@endevops/peppol-schema 0.0.1

package/src/peppol-validations/is-valid-iban.ts

@@ -0,0 +1,24 @@
+import { normalizeSpace } from './normalize-space';
+
+/**
+ * @description IBAN validation using mod 97 algorithm.
+ */
+export function isValidIBAN(iban: string): boolean {
+  const s = normalizeSpace(iban).replace(/[ \t\r\n]/g, '');
+  if (!/^[A-Z]{2}\d{2}[A-Za-z0-9]{0,30}$/.test(s)) return false;
+  const rearranged = s.slice(4) + s.slice(0, 4);
+  const converted = rearranged
+    .split('')
+    .map(ch => {
+      const code = ch.charCodeAt(0);
+      // A=10..Z=35, digits 0..9
+      return code >= 65 && code <= 90 ? String(code - 55) : ch;
+    })
+    .join('');
+  // mod 97 calculation on big integer string
+  let remainder = 0;
+  for (const c of converted) {
+    remainder = (remainder * 10 + (c.charCodeAt(0) - 48)) % 97;
+  }
+  return remainder === 1;
+}

package/src/peppol-validations/is-valid-mod11.ts

@@ -0,0 +1,19 @@
+import { normalizeSpace } from './normalize-space';
+
+/**
+ * @description Validates Norwegian organization numbers using mod11 algorithm.
+ */
+export function isValidMod11(val: string): boolean {
+  const s = normalizeSpace(val);
+  if (!/^\d+$/.test(s) || s.length < 2) return false;
+  const length = s.length - 1;
+  let weightedSum = 0;
+  // weights 2..7 repeated
+  for (let i = 0; i < length; i += 1) {
+    const digit = s.charCodeAt(length - 1 - i) - 48; // reverse to match XSLT reverse
+    const weight = (i % 6) + 2;
+    weightedSum += digit * weight;
+  }
+  const check = (11 - (weightedSum % 11)) % 11;
+  return check === Number(s[length]);
+}

package/src/peppol-validations/is-valid-mod97-0208.ts

@@ -0,0 +1,16 @@
+import { normalizeSpace } from './normalize-space';
+
+/**
+ * @description Belgian enterprise number validation (mod 97-0208)
+ */
+export function isValidMod97_0208(val: string): { success: true } | { success: false; expected: number; actual: number } {
+  const s = normalizeSpace(val);
+  const checkdigits = Number(s.substring(8, 10));
+  const main = Number(s.substring(0, 8));
+  const calculated = 97 - (main % 97);
+  const success = checkdigits === calculated;
+  if (success) {
+    return { success: true };
+  }
+  return { actual: checkdigits, expected: calculated, success: false };
+}

package/src/peppol-validations/luhn-check.ts

@@ -0,0 +1,21 @@
+import { normalizeSpace } from './normalize-space';
+
+/**
+ * @description Luhn algorithm check (used for credit card validation)
+ */
+export function luhnCheck(number: string): boolean {
+  const s = normalizeSpace(number);
+  if (!/^\d+$/.test(s)) return false;
+  let sum = 0;
+  let dbl = false;
+  for (let i = s.length - 1; i >= 0; i -= 1) {
+    let n = s.charCodeAt(i) - 48;
+    if (dbl) {
+      n *= 2;
+      if (n > 9) n -= 9;
+    }
+    sum += n;
+    dbl = !dbl;
+  }
+  return sum % 10 === 0;
+}

package/src/peppol-validations/normalize-space.ts

@@ -0,0 +1,7 @@
+/**
+ * @description Normalize whitespace in a string by replacing multiple whitespace characters with a single space and trimming.
+ */
+export function normalizeSpace(input: string): string {
+  const s = typeof input === 'string' ? input : input == null ? '' : String(input);
+  return s.replace(/\s+/g, ' ').trim();
+}

package/src/schemas/billing-base.ts

@@ -0,0 +1,362 @@
+import * as z from 'zod/mini';
+
+import { additionalDocumentReferenceSchema } from '#/schemas/fields/additional-document-reference-schema';
+import { allowanceChargeSchema } from '#/schemas/fields/allowance-charge-schema';
+import { billingReferenceSchema } from '#/schemas/fields/billing-references-schema';
+import { DEFAULT_CUSTOMIZATION_ID } from '#/schemas/fields/default-customization-id';
+import { DEFAULT_PROFILE_ID } from '#/schemas/fields/default-profile-id';
+import { deliverySchema } from '#/schemas/fields/delivery-schema';
+import { invoicePeriodSchema } from '#/schemas/fields/invoice-period-schema';
+import { legalMonetaryTotalSchema } from '#/schemas/fields/legal-monetary-total-schema';
+import { orderReferenceSchema } from '#/schemas/fields/order-reference-schema';
+import { partyBaseSchema } from '#/schemas/fields/party-base-schema';
+import { payeePartySchema } from '#/schemas/fields/payee-party';
+import { paymentMeansSchema } from '#/schemas/fields/payment-means-schema';
+import { paymentTermsSchema } from '#/schemas/fields/payment-terms-schema';
+import { taxRepresentativeSchema } from '#/schemas/fields/tax-representative-party-schema';
+import { taxTotalsBaseSchema } from '#/schemas/fields/tax-totals';
+import { currencyCodeSchema } from '#/schemas/values/currency-codes';
+
+/**
+ * @description Base schema for a billing document.
+ *
+ * @see {@link creditNoteSchema} - the credit note schema
+ * @see {@link invoiceSchema} - the invoice schema
+ */
+export const billingBaseSchema = z.object({
+  /**
+   * @description An identification of the specification containing the total set of rules regarding semantic content, cardinalities, and business rules to which
+   * the data contained in the intance document conforms.
+   *
+   * @default `urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0`
+   *
+   * @summary Specification identifier
+   *
+   * @cardinality 1..1
+   *
+   * @name `cbc:CustomizationID`
+   */
+  customizationId: z._default(
+    z
+      .string()
+      .check(
+        z.startsWith('urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0', {
+          error:
+            "PEPPOL-EN16931-R004: Specification identifier MUST have the value 'urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0'.",
+        })
+      ),
+    DEFAULT_CUSTOMIZATION_ID
+  ),
+  /**
+   * @description Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.
+   *
+   * @default `urn:fdc:peppol.eu:2017:poacc:billing:01:1.0`
+   *
+   * @summary Business process type
+   *
+   * @name `cbc:ProfileID`
+   */
+  profileId: z._default(
+    z
+      .string()
+      .check(
+        z.regex(
+          /^urn:fdc:peppol.eu:2017:poacc:billing:(\d{2}):1\.0$/,
+          "PEPPOL-EN16931-R007: Business process MUST be in the format 'urn:fdc:peppol.eu:2017:poacc:billing:NN:1.0' where NN indicates the process number."
+        )
+      ),
+    DEFAULT_PROFILE_ID
+  ),
+  /**
+   * @description A using identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify
+   * the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used.
+   *
+   * @example
+   *   33445566;
+   *
+   * @summary Invoice number
+   *
+   * @name `cbc:ID`
+   */
+  id: z.string(),
+  /**
+   * @description The date when the invoice was issued.
+   *
+   * @example
+   *   `2017-11-01`;
+   *
+   * @summary Invoice issue date
+   *
+   * @format `YYYY-MM-DD`
+   *
+   * @name `cbc:IssueDate`
+   */
+  issueDate: z.iso.date(),
+  /**
+   * @description Invoice note A textual note that gives unstructured information that is relevant to the Credit Note as a whole.
+   *
+   * @example
+   *   Please note our new phone number 33 44 55 66
+   *
+   * @name `cbc:Note`
+   */
+  note: z.optional(z.string()),
+  /**
+   * @description The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of
+   * issue of the invoice, according to the VAT directive.This element is required if the Value added tax point date is different from the Invoice
+   * issue date.
+   *
+   * @example
+   *   2017 - 11 - 01;
+   *
+   * @summary Value added tax point date
+   *
+   * @name `cbc:TaxPointDate`
+   */
+  taxPointDate: z.optional(z.iso.date()),
+  /**
+   * @description The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency. Only one currency shall be used in
+   * the Invoice, except for the VAT accounting currency code (BT-6) and the invoice total VAT amount in accounting currency (BT-111).
+   *
+   * @example
+   *   EUR;
+   *
+   * @summary Invoice currency code
+   *
+   * @name `cbc:DocumentCurrencyCode`
+   */
+  documentCurrencyCode: currencyCodeSchema(),
+  /**
+   * @description The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller. Shall be used in combination
+   * with the Invoice total VAT amount in accounting currency (BT-111), when the VAT accounting currency code differs from the Invoice currency code.
+   *
+   * @example
+   *   SEK;
+   *
+   * @summary VAT accounting currency code
+   *
+   * @name `cbc:TaxCurrencyCode`
+   */
+  taxCurrencyCode: z.optional(currencyCodeSchema()),
+  /**
+   * @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
+   *
+   * @example
+   *   `4217:2323:2323`;
+   *
+   * @summary Buyer accounting reference
+   *
+   * @name `cbc:AccountingCost`
+   */
+  accountingCost: z.optional(z.string()),
+  /**
+   * @description An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).
+   *
+   * @example
+   *   `abs1234`;
+   *
+   * @summary Buyer reference
+   *
+   * @name `cbc:BuyerReference`
+   */
+  buyerReference: z.optional(z.string()),
+  /**
+   * @description A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoiceing period
+   * start date and/or end date must be used.
+   *
+   * @summary DELIVERY OR INVOICE PERIOD
+   *
+   * @name `cac:InvoicePeriod`
+   */
+  invoicePeriod: z.optional(invoicePeriodSchema),
+  /**
+   * @summary ORDER AND SALES ORDER REFERENCE
+   *
+   * @name `cac:OrderReference`
+   */
+  orderReference: z.optional(orderReferenceSchema),
+  /**
+   * @summary PRECEDING INVOICE REFERENCE (0..n)
+   *
+   * @name `cac:BillingReference`
+   */
+  billingReferences: z.optional(z.array(billingReferenceSchema)),
+  /**
+   * @summary DESPATCH ADVICE REFERENCE
+   *
+   * @name `cac:DespatchDocumentReference`
+   */
+  despatchDocumentReference: z.optional(
+    z.object({
+      /**
+       * @description An identifier of a referenced despatch advice.
+       *
+       * @example
+       *   `desp98`;
+       *
+       * @summary Despatch advice reference
+       *
+       * @name `cbc:ID`
+       */
+      id: z.string(),
+    })
+  ),
+  /**
+   * @summary RECEIPT ADVICE REFERENCE
+   *
+   * @name `cac:ReceiptDocumentReference`
+   */
+  receiptDocumentReference: z.optional(
+    z.object({
+      /**
+       * @description An identifier of a referenced receiving advice.
+       *
+       * @example
+       *   `rec98`;
+       *
+       * @summary Receiving advice reference
+       *
+       * @name `cbc:ID`
+       */
+      id: z.string(),
+    })
+  ),
+  /**
+   * @summary TENDER OR LOT REFERENCE
+   *
+   * @name `cac:OriginatorDocumentReference`
+   */
+  originatorDocumentReference: z.optional(
+    z.object({
+      /**
+       * @description The identification of the call for tender or lot the invoice relates to.
+       *
+       * @example
+       *   `PPID-123`;
+       *
+       * @summary Tender or lot reference
+       *
+       * @name `cbc:ID`
+       */
+      id: z.string(),
+    })
+  ),
+
+  /**
+   * @summary CONTRACT REFERENCE
+   *
+   * @name `cac:ContractDocumentReference`
+   */
+  contractDocumentReference: z.optional(
+    z.object({
+      /**
+       * @description An identifier of a referenced contract.
+       *
+       * @example
+       *   `123Contractref`;
+       *
+       * @summary Contract reference
+       *
+       * @name `cbc:ID`
+       */
+      id: z.string(),
+    })
+  ),
+
+  /**
+   * @description A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The
+   * additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external
+   * document (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
+   *
+   * @summary ADDITIONAL SUPPORTING DOCUMENTS
+   *
+   * @name `cac:AdditionalDocumentReference`
+   */
+  additionalDocumentReferences: z.optional(z.array(additionalDocumentReferenceSchema)),
+
+  /**
+   * @description A group of business terms providing information about the seller.
+   *
+   * @summary SELLER
+   *
+   * @name `cac:AccountingSupplierParty`
+   */
+  accountingSupplierParty: partyBaseSchema,
+
+  /**
+   * @description A group of business terms providing information about the Buyer.
+   *
+   * @summary BUYER
+   *
+   * @name `cac:AccountingCustomerParty`
+   */
+  accountingCustomerParty: partyBaseSchema,
+
+  /**
+   * @description A group of business terms providing information about the Payee, i.e. the role that received the payment. Shall be used wwhen the payee is
+   * different from the seller.
+   *
+   * @summary PAYEE
+   *
+   * @name cac:PayeeParty
+   */
+  payeeParty: z.optional(payeePartySchema),
+
+  /**
+   * @description SELLER TAX REPRESENTATIVE PARTY.
+   *
+   * @name cac:TaxRepresentativeParty
+   */
+  taxRepresentativeParty: z.optional(taxRepresentativeSchema),
+
+  /**
+   * @description DELIVERY INFORMATION.
+   *
+   * @name cac:Delivery
+   */
+  delivery: z.optional(deliverySchema),
+
+  /**
+   * @summary PAYMENT INSTRUCTIONS
+   * @summary A group of business terms providing information about the payment.
+   *
+   * @name cac:PaymentMeans
+   */
+  paymentMeans: z.optional(z.array(paymentMeansSchema)),
+
+  /**
+   * @example
+   *   Net within 30 days
+   *
+   * @summary PAYMENT TERMS
+   *
+   * @name cac:PaymentTerms
+   */
+  paymentTerms: z.optional(paymentTermsSchema),
+
+  /**
+   * @description A group of business terms providing information about allowances applicable to the Invoice as a whole. A group of business terms providing
+   * information about charges and taxes other than VAT, applicable to the Invoice as a whole.
+   *
+   * @summary DOCUMENT LEVEL ALLOWANCES AND CHARGES
+   *
+   * @name cac:AllowanceCharge
+   */
+  allowanceCharges: z.optional(z.array(allowanceChargeSchema)),
+
+  /**
+   * @description When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.
+   *
+   * @summary TAX TOTAL
+   *
+   * @name cac:TaxTotal
+   */
+  taxTotals: z.array(taxTotalsBaseSchema).check(z.minLength(1), z.maxLength(2)),
+
+  /**
+   * @summary DOCUMENT TOTALS
+   *
+   * @name cac:LegalMonetaryTotal
+   */
+  legalMonetaryTotal: legalMonetaryTotalSchema,
+});

package/src/schemas/credit-note.ts

@@ -0,0 +1,28 @@
+import * as z from 'zod/mini';
+
+import { billingBaseSchema } from '#/schemas/billing-base';
+import { creditNoteLineSchema } from '#/schemas/fields/credit-note-line-schema';
+import { creditNoteTypeCodeSchema } from '#/schemas/values/credit-note-type-code-schema';
+
+/**
+ * @description Main UBL Credit Note schema (camelCase properties)
+ */
+export const creditNoteSchema = z.extend(billingBaseSchema, {
+  /**
+   * @description CREDIT NOTE LINE.
+   *
+   * @name cac:CreditNoteLine (1..n)
+   */
+  creditNoteLines: z.array(creditNoteLineSchema).check(z.minLength(1)),
+  /**
+   * @description Invoice type code A code specifying the functional type of the Credit Note.
+   *
+   * @example
+   *   381;
+   *
+   * @name cbc:CreditNoteTypeCode
+   */
+  creditNoteTypeCode: creditNoteTypeCodeSchema(),
+});
+
+export type PeppolCreditNote = z.infer<typeof creditNoteSchema>;

package/src/schemas/document-response-document-reference-schema.ts

@@ -0,0 +1,37 @@
+import * as z from 'zod/mini';
+
+import { documentTypeCodeSchema } from '#/schemas/values/document-type-codes';
+
+export const documentResponseDocumentReferenceSchema = z.object({
+  /**
+   * @description Identifies the document on which the message level response is based.
+   *
+   * @example
+   *   `EnvelopeID-12345`;
+   *
+   * @summary Document identifier
+   *
+   * @name `cbc:ID`
+   */
+  id: z.string(),
+  /**
+   * @description The type of the document being referred to, expressed as a code.
+   *
+   * @summary Document type code
+   *
+   * @name `cbc:DocumentTypeCode`
+   */
+  documentTypeCode: z.optional(documentTypeCodeSchema()),
+  /**
+   * @description The version of the document that has been identifier with the document identifier.
+   *
+   * @example
+   *   `2`;
+   *
+   * @summary Document version identifier
+   *
+   * @name `cbc:VersionID`
+   */
+  versionId: z.optional(z.string()),
+});
+export type PeppolMessageLevelDocumentResponseDocumentReference = z.infer<typeof documentResponseDocumentReferenceSchema>;

package/src/schemas/document-response-document-schema.ts

@@ -0,0 +1,34 @@
+import * as z from 'zod/mini';
+
+import { applicationResponseTypeCodeSchema } from '#/schemas/values/application-response-type-codes';
+
+/**
+ * @summary Response information
+ *
+ * @name `cac:Response`
+ *
+ * @cardinality (1..1)
+ *
+ * @see {@link messageLevelResponseDocumentResponseSchema}
+ */
+export const documentResponseDocumentSchema = z.object({
+  /**
+   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+   * response states that the document was not processed because of identified issues.
+   *
+   * @example
+   *   `RE`;
+   *
+   * @summary Message response code
+   *
+   * @name `cbc:ResponseCode`
+   */
+  responseCode: applicationResponseTypeCodeSchema(),
+  /**
+   * @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.
+   *
+   * @summary Response textual notes
+   */
+  description: z.optional(z.string()),
+});
+export type PeppolMessageLevelResponseDocumentResponseDocument = z.infer<typeof documentResponseDocumentSchema>;

package/src/schemas/document-response-line-response-content.ts

@@ -0,0 +1,43 @@
+import * as z from 'zod/mini';
+
+import { applicationResponseTypeCodeSchema } from '#/schemas/values/application-response-type-codes';
+
+export const documentResponseLineResponseContent = z.object({
+  /**
+   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+   * response states that the document was not processed because of identified issues.
+   *
+   * @example
+   *   `RE`;
+   *
+   * @summary Line response code
+   *
+   * @name `cbc:ResponseCode`
+   */
+  responseCode: applicationResponseTypeCodeSchema(),
+  /**
+   * @description The description of the issued identifier in the transaction document.
+   *
+   * @example
+   *   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
+   *
+   * @summary Issue description
+   *
+   * @name `cbc:Description`
+   */
+  description: z.string(),
+  /**
+   * @name `cac:Status`
+   */
+  status: z.object({
+    /**
+     * @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
+     *
+     * @summary Issue type coded
+     *
+     * @name `cbc:StatusReasonCode`
+     */
+    statusReasonCode: z.enum(['BV', 'BW', 'SV']),
+  }),
+});
+export type DocumentResponseLineResponseContent = z.infer<typeof documentResponseLineResponseContent>;

package/src/schemas/document-response-line-response-schema.ts

@@ -0,0 +1,33 @@
+import * as z from 'zod/mini';
+
+import { documentResponseLineResponseContent } from '#/schemas/document-response-line-response-content';
+
+export const documentResponseLineResponseSchema = z.object({
+  /**
+   * @description Identifies the line in the business document to which the reported issue applies.
+   *
+   * @summary Line reference
+   *
+   * @name `cac:LineReference`
+   */
+  lineReference: z.object({
+    /**
+     * @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
+     * document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
+     * provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
+     * mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
+     *
+     * @example
+     *   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
+     *
+     * @summary Section identifier
+     */
+    lineId: z.string(),
+  }),
+  /**
+   * @summary Line response information
+   */
+  response: documentResponseLineResponseContent,
+});
+
+export type PeppolMessageLevelDocumentResponseLineResponse = z.infer<typeof documentResponseLineResponseSchema>;