@notabene/javascript-sdk 2.16.0-next.1 → 2.16.0

package/dist/cjs/notabene.d.ts

@@ -10,6 +10,26 @@ export declare interface Account {
     identifier?: string;
 }
 
+/**
+ * Additional Document Reference
+ * Reference to an additional document related to the invoice
+ */
+declare interface AdditionalDocumentReference {
+    /**
+     * Document identifier
+     */
+    id: string;
+    /**
+     * Type of document
+     * Uses UBL Document Type Code standard
+     */
+    documentType?: DocumentTypeCode;
+    /**
+     * URL where the document can be accessed
+     */
+    url?: string;
+}
+
 /**
  * Address
  * Represents a physical address
@@ -226,8 +246,8 @@ export declare enum AgentType {
 }
 
 declare interface BaseRequestConfig {
-    originatorId?: DID_2;
-    beneficiaryId?: DID_2;
+    originatorId?: IRI;
+    beneficiaryId?: IRI;
 }
 
 /**
@@ -896,6 +916,33 @@ export declare type DID = `did:${string}:${string}`;
  */
 declare type DID_2 = `did:${string}:${string}`;
 
+/**
+ * UBL Document Type Code standard
+ * Based on UBL 2.1 document types
+ *
+ * @see {@link http://docs.oasis-open.org/ubl/os-UBL-2.1/cl/gc/default/DocumentTypeCode-2.1.gc | UBL Document Type Codes}
+ */
+declare enum DocumentTypeCode {
+    Order = "Order",
+    OrderResponse = "OrderResponse",
+    OrderChange = "OrderChange",
+    OrderCancellation = "OrderCancellation",
+    Quotation = "Quotation",
+    DespatchAdvice = "DespatchAdvice",
+    ReceiptAdvice = "ReceiptAdvice",
+    Invoice = "Invoice",
+    CreditNote = "CreditNote",
+    DebitNote = "DebitNote",
+    SelfBilledInvoice = "SelfBilledInvoice",
+    RemittanceAdvice = "RemittanceAdvice",
+    Statement = "Statement",
+    CertificateOfOrigin = "CertificateOfOrigin",
+    Contract = "Contract",
+    Timesheet = "Timesheet",
+    Waybill = "Waybill",
+    Manifest = "Manifest"
+}
+
 /**
  * Digital Token Identifier (DTI) following ISO 24165 standard
  *
@@ -1143,6 +1190,113 @@ export declare type InvalidValue<T> = {
     errors: ValidationError[];
 };
 
+/**
+ * Invoice
+ * Represents a detailed invoice as defined in TAIP-16
+ *
+ * @see {@link https://github.com/TransactionAuthorizationProtocol/TAIPs/blob/main/TAIPs/taip-16.md | TAIP-16: Invoices}
+ */
+export declare interface Invoice {
+    /**
+     * Unique identifier for the invoice
+     *
+     * @example "INV001"
+     * @validation Must be a unique identifier for the invoice
+     */
+    id: string;
+    /**
+     * Date when the invoice was issued
+     * ISO 8601 date format (YYYY-MM-DD)
+     *
+     * @example "2025-04-22"
+     * @validation Must be a valid date in ISO 8601 format
+     */
+    issueDate: string;
+    /**
+     * Currency code for the invoice amounts
+     * ISO 4217 currency code
+     * Should be consistent with the currency field in the Payment Request if present
+     *
+     * @example "USD"
+     * @example "EUR"
+     * @validation Must be a valid ISO 4217 currency code
+     */
+    currencyCode: IsoCurrency;
+    /**
+     * Individual items being invoiced
+     *
+     * @validation Must be an array of LineItem objects
+     */
+    lineItems: LineItem[];
+    /**
+     * Aggregate tax information
+     *
+     * @validation Must be a TaxTotal object if present
+     */
+    taxTotal?: TaxTotal;
+    /**
+     * Total amount of the invoice, including taxes
+     * Must match the amount in the Payment Request body
+     *
+     * @validation Must be a positive number
+     */
+    total: number;
+    /**
+     * Sum of line totals before taxes
+     *
+     * @validation Must be a positive number if present
+     */
+    subTotal?: number;
+    /**
+     * Date when payment is due
+     * ISO 8601 date format (YYYY-MM-DD)
+     *
+     * @example "2025-05-22"
+     * @validation Must be a valid date in ISO 8601 format if present
+     */
+    dueDate?: string;
+    /**
+     * Additional notes or terms for the invoice
+     *
+     * @validation Must be a string if present
+     */
+    note?: string;
+    /**
+     * Terms of payment
+     *
+     * @example "Net 30"
+     * @validation Must be a string if present
+     */
+    paymentTerms?: string;
+    /**
+     * Buyer's accounting code
+     * Used to route costs to specific accounts
+     *
+     * @validation Must be a string if present
+     */
+    accountingCost?: string;
+    /**
+     * Reference to a related order
+     *
+     * @validation Must be an OrderReference object if present
+     */
+    orderReference?: OrderReference;
+    /**
+     * References to additional documents
+     *
+     * @validation Must be an array of AdditionalDocumentReference objects if present
+     */
+    additionalDocumentReference?: AdditionalDocumentReference[];
+}
+
+/** Output fields populated by the component on completion */
+export declare interface InvoiceReaderResponse {
+    /** TAIP-16 compliant invoice data (populated by the component after PDF parsing) */
+    invoice?: Invoice;
+    merchant?: Party;
+    customer?: Party;
+}
+
 /**
  * Internationalized Resource Identifier (IRI)
  * A unique identifier that may contain international characters.
@@ -1165,6 +1319,326 @@ declare type ISOCountryCode = string;
  */
 declare type ISOCurrency = string;
 
+/**
+ * ISO 4217 Currency Codes
+ * Three-letter codes representing currencies according to the ISO 4217 standard.
+ *
+ * @see {@link https://www.iso.org/iso-4217-currency-codes.html | ISO 4217}
+ */
+declare type IsoCurrency = 
+/** United Arab Emirates Dirham */
+"AED"
+/** Afghan Afghani */
+| "AFN"
+/** Albanian Lek */
+| "ALL"
+/** Armenian Dram */
+| "AMD"
+/** Netherlands Antillean Guilder */
+| "ANG"
+/** Angolan Kwanza */
+| "AOA"
+/** Argentine Peso */
+| "ARS"
+/** Australian Dollar */
+| "AUD"
+/** Aruban Florin */
+| "AWG"
+/** Azerbaijani Manat */
+| "AZN"
+/** Bosnia and Herzegovina Convertible Mark */
+| "BAM"
+/** Barbados Dollar */
+| "BBD"
+/** Bangladeshi Taka */
+| "BDT"
+/** Bulgarian Lev */
+| "BGN"
+/** Bahraini Dinar */
+| "BHD"
+/** Burundian Franc */
+| "BIF"
+/** Bermudian Dollar */
+| "BMD"
+/** Brunei Dollar */
+| "BND"
+/** Boliviano */
+| "BOB"
+/** Brazilian Real */
+| "BRL"
+/** Bahamian Dollar */
+| "BSD"
+/** Bhutanese Ngultrum */
+| "BTN"
+/** Botswana Pula */
+| "BWP"
+/** Belarusian Ruble */
+| "BYN"
+/** Belize Dollar */
+| "BZD"
+/** Canadian Dollar */
+| "CAD"
+/** Congolese Franc */
+| "CDF"
+/** Swiss Franc */
+| "CHF"
+/** Chilean Peso */
+| "CLP"
+/** Chinese Yuan */
+| "CNY"
+/** Colombian Peso */
+| "COP"
+/** Costa Rican Colon */
+| "CRC"
+/** Cuban Peso */
+| "CUP"
+/** Cape Verde Escudo */
+| "CVE"
+/** Czech Koruna */
+| "CZK"
+/** Djiboutian Franc */
+| "DJF"
+/** Danish Krone */
+| "DKK"
+/** Dominican Peso */
+| "DOP"
+/** Algerian Dinar */
+| "DZD"
+/** Egyptian Pound */
+| "EGP"
+/** Eritrean Nakfa */
+| "ERN"
+/** Ethiopian Birr */
+| "ETB"
+/** Euro */
+| "EUR"
+/** Fiji Dollar */
+| "FJD"
+/** Falkland Islands Pound */
+| "FKP"
+/** Pound Sterling */
+| "GBP"
+/** Georgian Lari */
+| "GEL"
+/** Ghanaian Cedi */
+| "GHS"
+/** Gibraltar Pound */
+| "GIP"
+/** Gambian Dalasi */
+| "GMD"
+/** Guinean Franc */
+| "GNF"
+/** Guatemalan Quetzal */
+| "GTQ"
+/** Guyanese Dollar */
+| "GYD"
+/** Hong Kong Dollar */
+| "HKD"
+/** Honduran Lempira */
+| "HNL"
+/** Croatian Kuna */
+| "HRK"
+/** Haitian Gourde */
+| "HTG"
+/** Hungarian Forint */
+| "HUF"
+/** Indonesian Rupiah */
+| "IDR"
+/** Israeli New Shekel */
+| "ILS"
+/** Indian Rupee */
+| "INR"
+/** Iraqi Dinar */
+| "IQD"
+/** Iranian Rial */
+| "IRR"
+/** Icelandic Króna */
+| "ISK"
+/** Jamaican Dollar */
+| "JMD"
+/** Jordanian Dinar */
+| "JOD"
+/** Japanese Yen */
+| "JPY"
+/** Kenyan Shilling */
+| "KES"
+/** Kyrgyzstani Som */
+| "KGS"
+/** Cambodian Riel */
+| "KHR"
+/** Comoro Franc */
+| "KMF"
+/** North Korean Won */
+| "KPW"
+/** South Korean Won */
+| "KRW"
+/** Kuwaiti Dinar */
+| "KWD"
+/** Cayman Islands Dollar */
+| "KYD"
+/** Kazakhstani Tenge */
+| "KZT"
+/** Lao Kip */
+| "LAK"
+/** Lebanese Pound */
+| "LBP"
+/** Sri Lankan Rupee */
+| "LKR"
+/** Liberian Dollar */
+| "LRD"
+/** Lesotho Loti */
+| "LSL"
+/** Libyan Dinar */
+| "LYD"
+/** Moroccan Dirham */
+| "MAD"
+/** Moldovan Leu */
+| "MDL"
+/** Malagasy Ariary */
+| "MGA"
+/** Macedonian Denar */
+| "MKD"
+/** Myanmar Kyat */
+| "MMK"
+/** Mongolian Tugrik */
+| "MNT"
+/** Macanese Pataca */
+| "MOP"
+/** Mauritanian Ouguiya */
+| "MRU"
+/** Mauritian Rupee */
+| "MUR"
+/** Maldivian Rufiyaa */
+| "MVR"
+/** Malawian Kwacha */
+| "MWK"
+/** Mexican Peso */
+| "MXN"
+/** Malaysian Ringgit */
+| "MYR"
+/** Mozambican Metical */
+| "MZN"
+/** Namibian Dollar */
+| "NAD"
+/** Nigerian Naira */
+| "NGN"
+/** Nicaraguan Córdoba */
+| "NIO"
+/** Norwegian Krone */
+| "NOK"
+/** Nepalese Rupee */
+| "NPR"
+/** New Zealand Dollar */
+| "NZD"
+/** Omani Rial */
+| "OMR"
+/** Panamanian Balboa */
+| "PAB"
+/** Peruvian Sol */
+| "PEN"
+/** Papua New Guinean Kina */
+| "PGK"
+/** Philippine Peso */
+| "PHP"
+/** Pakistani Rupee */
+| "PKR"
+/** Polish Złoty */
+| "PLN"
+/** Paraguayan Guaraní */
+| "PYG"
+/** Qatari Riyal */
+| "QAR"
+/** Romanian Leu */
+| "RON"
+/** Serbian Dinar */
+| "RSD"
+/** Russian Ruble */
+| "RUB"
+/** Rwandan Franc */
+| "RWF"
+/** Saudi Riyal */
+| "SAR"
+/** Solomon Islands Dollar */
+| "SBD"
+/** Seychelles Rupee */
+| "SCR"
+/** Sudanese Pound */
+| "SDG"
+/** Swedish Krona */
+| "SEK"
+/** Singapore Dollar */
+| "SGD"
+/** Saint Helena Pound */
+| "SHP"
+/** Sierra Leonean Leone */
+| "SLL"
+/** Somali Shilling */
+| "SOS"
+/** Surinamese Dollar */
+| "SRD"
+/** South Sudanese Pound */
+| "SSP"
+/** São Tomé and Príncipe Dobra */
+| "STN"
+/** Salvadoran Colón */
+| "SVC"
+/** Syrian Pound */
+| "SYP"
+/** Swazi Lilangeni */
+| "SZL"
+/** Thai Baht */
+| "THB"
+/** Tajikistani Somoni */
+| "TJS"
+/** Turkmenistan Manat */
+| "TMT"
+/** Tunisian Dinar */
+| "TND"
+/** Tongan Paʻanga */
+| "TOP"
+/** Turkish Lira */
+| "TRY"
+/** Trinidad and Tobago Dollar */
+| "TTD"
+/** New Taiwan Dollar */
+| "TWD"
+/** Tanzanian Shilling */
+| "TZS"
+/** Ukrainian Hryvnia */
+| "UAH"
+/** Ugandan Shilling */
+| "UGX"
+/** United States Dollar */
+| "USD"
+/** Uruguayan Peso */
+| "UYU"
+/** Uzbekistan Som */
+| "UZS"
+/** Venezuelan Bolívar Soberano */
+| "VES"
+/** Vietnamese Đồng */
+| "VND"
+/** Vanuatu Vatu */
+| "VUV"
+/** Samoan Tala */
+| "WST"
+/** CFA Franc BEAC */
+| "XAF"
+/** East Caribbean Dollar */
+| "XCD"
+/** CFA Franc BCEAO */
+| "XOF"
+/** CFP Franc */
+| "XPF"
+/** Yemeni Rial */
+| "YER"
+/** South African Rand */
+| "ZAR"
+/** Zambian Kwacha */
+| "ZMW"
+/** Zimbabwean Dollar */
+| "ZWL";
+
 /**
  * A point in time, represented as a day within the calendar year. Compliant with ISO 8601.
  * Format: YYYY-MM-DD
@@ -1324,6 +1798,69 @@ export declare type LEI = string;
  */
 declare type LEICode = string;
 
+/**
+ * Line Item
+ * Represents an individual item in an invoice
+ */
+declare interface LineItem {
+    /**
+     * Unique identifier for the line item within the invoice
+     */
+    id: string;
+    /**
+     * Description of the item or service
+     */
+    description: string;
+    /**
+     * Product name
+     * Based on schema.org/Product
+     * If not provided, description serves as the display name
+     *
+     * @example "Premium Widget Model A"
+     */
+    name?: string;
+    /**
+     * URL to an image of the product
+     * Based on schema.org/Product
+     *
+     * @example "https://example.com/products/widget-a.jpg"
+     */
+    image?: string;
+    /**
+     * URL to the product page
+     * Based on schema.org/Product
+     *
+     * @example "https://example.com/products/widget-a"
+     */
+    url?: string;
+    /**
+     * Quantity of the item
+     */
+    quantity: number;
+    /**
+     * Unit of measure code
+     * Uses UBL Unit of Measure Code standard
+     *
+     * @example UnitCode.Each
+     * @example UnitCode.Kilogram
+     * @example UnitCode.Hour
+     */
+    unitCode?: UnitCode;
+    /**
+     * Price per unit
+     */
+    unitPrice: number;
+    /**
+     * Total amount for this line item
+     * Typically quantity × unitPrice
+     */
+    lineTotal: number;
+    /**
+     * Tax category information specific to this line item
+     */
+    taxCategory?: TaxCategory;
+}
+
 /**
  * Local Legal Person Name ID
  * Represents a local name identifier for a legal person
@@ -1530,6 +2067,16 @@ declare type NaturalPersonNameID = {
     nameIdentifierType?: NaturalPersonNameTypeCode;
 };
 
+/** Represents a natural person's name identifier */
+declare interface NaturalPersonNameId {
+    /** This may be the family name, maiden name, or married name */
+    primaryIdentifier: string;
+    /** These may be forenames, given names, initials, or other secondary names */
+    secondaryIdentifier?: string;
+    /** The nature of the name specified */
+    naturalPersonNameIdentifierType: NaturalPersonNameTypeCode_2;
+}
+
 declare type NaturalPersonNameIDV2 = {
     primaryIdentifier?: string;
     secondaryIdentifier?: string;
@@ -1544,10 +2091,20 @@ declare type NaturalPersonNameIDV2 = {
  */
 declare type NaturalPersonNameTypeCode = 'ALIA' | 'BIRT' | 'MAID' | 'LEGL' | 'MISC';
 
+/**
+ * IVMS101 Core Types
+ * Shared type definitions used by both IVMS101.2020 and IVMS101.2023 versions
+ */
+
+/** Codes representing the nature of a natural person's name */
+declare type NaturalPersonNameTypeCode_2 = "ALIA" | "BIRT" | "MAID" | "LEGL" | "MISC";
+
 declare type NaturalPersonNameV2 = Omit<NaturalPersonName, 'nameIdentifier'> & {
     nameIdentifier?: NaturalPersonNameIDV2[];
 };
 
+declare type NaturalPersonNationalIdentifierTypeCode = Omit<NationalIdentifierTypeCode_2, "LEIX" | "RAID">;
+
 declare type NaturalPersonV2 = Omit<NaturalPerson_2, 'name'> & {
     name: NaturalPersonNameV2;
 };
@@ -1624,6 +2181,17 @@ declare class Notabene {
      * @public
      */
     createDepositRequest(value: DepositRequest, options?: DepositRequestOptions, callbacks?: CallbackOptions): EmbeddedComponent<DepositRequest, DepositRequestOptions>;
+    /**
+     * Creates an invoice reader component for extracting TAIP-16 invoice data from PDF invoices
+     *
+     * The component provides a PDF drag-and-drop upload UI. On upload, the PDF is
+     * parsed and the extracted invoice data is returned. On completion,
+     * the response contains the TAIP-16 invoice data.
+     *
+     * @returns A new EmbeddedComponent instance for invoice reader creation
+     * @public
+     */
+    createInvoiceReader(): EmbeddedComponent<InvoiceReaderResponse, Record<string, never>>;
     /**
      * Creates a deposit assist component
      *
@@ -1685,6 +2253,22 @@ export declare interface NotabeneConfig {
     locale?: string;
 }
 
+/**
+ * Order Reference
+ * Reference to a related order
+ */
+declare interface OrderReference {
+    /**
+     * Order identifier
+     */
+    id: string;
+    /**
+     * Date when the order was issued
+     * ISO 8601 date format (YYYY-MM-DD)
+     */
+    issueDate?: string;
+}
+
 /**
  * Organization Interface
  * Represents a legal entity (company, institution, merchant) in TAP transactions.
@@ -1927,6 +2511,8 @@ declare interface Participant {
     telephone?: string;
 }
 
+declare type Party = Person_2 | Organization;
+
 declare type PartyType = "originator" | "beneficiary" | "customer" | "merchant" | "principal";
 
 /**
@@ -1962,6 +2548,115 @@ declare type Person = {
     legalPerson?: LegalPerson_2;
 };
 
+/**
+ * Person Interface
+ * Represents a natural person (individual) in TAP transactions.
+ * Supports both schema.org/Person properties and IVMS101 identity data for compliance.
+ *
+ * **Privacy Considerations**: For natural person information, consider using selective disclosure
+ * (TAIP-8) to protect sensitive data, especially when including IVMS101 fields like national
+ * identifiers and detailed addresses.
+ *
+ * @example
+ * ```typescript
+ * // Basic person with schema.org properties
+ * const basicPerson: Person = {
+ *   "@id": "did:example:alice",
+ *   "@type": "https://schema.org/Person",
+ *   name: "Alice Johnson",
+ *   email: "alice@example.com"
+ * };
+ *
+ * // Person with IVMS101 compliance data
+ * const compliancePerson: Person = {
+ *   "@id": "did:example:bob",
+ *   "@type": "https://schema.org/Person",
+ *   name: [{
+ *     primaryIdentifier: "Robert",
+ *     secondaryIdentifier: "Smith",
+ *     nameIdentifierType: "LEGL"
+ *   }],
+ *   geographicAddress: [{
+ *     addressType: "HOME",
+ *     streetName: "123 Main Street",
+ *     buildingNumber: "123",
+ *     postCode: "12345",
+ *     townName: "Example City",
+ *     country: "US"
+ *   }],
+ *   nationalIdentifier: {
+ *     nationalIdentifier: "123-45-6789",
+ *     nationalIdentifierType: "ARNU", // Social Security Number
+ *     countryOfIssue: "US"
+ *   },
+ *   dateAndPlaceOfBirth: {
+ *     dateOfBirth: "1990-01-15",
+ *     placeOfBirth: "New York, NY, US"
+ *   },
+ *   countryOfResidence: "US"
+ * };
+ * ```
+ *
+ * @see {@link https://github.com/TransactionAuthorizationProtocol/TAIPs/blob/main/TAIPs/taip-6.md | TAIP-6: Party Identification}
+ * @see {@link https://github.com/TransactionAuthorizationProtocol/TAIPs/blob/main/TAIPs/taip-8.md | TAIP-8: Selective Disclosure}
+ */
+declare interface Person_2 extends Participant {
+    "@type": "https://schema.org/Person";
+    /**
+     * SHA-256 hash of the normalized participant name
+     * Used for privacy-preserving name matching per TAIP-12
+     * @see {@link https://github.com/TransactionAuthorizationProtocol/TAIPs/blob/main/TAIPs/taip-12.md | TAIP-12: Privacy-Preserving Name Matching}
+     */
+    nameHash?: string;
+    /**
+     * Customer identification string
+     * Internal identifier used by the institution for this person
+     * @example "CUST-123456"
+     */
+    customerIdentification?: string;
+    /**
+     * Person's name
+     * Can be a simple string or structured IVMS101 name identifiers
+     * For compliance use cases, IVMS101 format provides more detailed name structure
+     * @example "Alice Johnson" // Simple string
+     * @example [{ primaryIdentifier: "Alice", secondaryIdentifier: "Johnson", nameIdentifierType: "LEGL" }] // IVMS101
+     */
+    name?: string | NaturalPersonNameId[];
+    /**
+     * Geographic addresses associated with the person
+     * IVMS101 format addresses for travel rule compliance
+     * Supports multiple address types (HOME, BIZZ, etc.)
+     * @example [{ addressType: "HOME", streetName: "123 Main St", townName: "City", country: "US" }]
+     */
+    geographicAddress?: Address_2[];
+    /**
+     * National identification documents
+     * Government-issued identifiers like passport, SSN, driver's license
+     * **Privacy**: Consider selective disclosure for sensitive ID information
+     * @example { nationalIdentifier: "123-45-6789", nationalIdentifierType: "ARNU", countryOfIssue: "US" }
+     */
+    nationalIdentifier?: NationalIdentification_2<NaturalPersonNationalIdentifierTypeCode>;
+    /**
+     * Date and place of birth information
+     * Used for identity verification and compliance
+     * **Privacy**: Highly sensitive data - recommend selective disclosure
+     */
+    dateAndPlaceOfBirth?: {
+        /** Date of birth in ISO 8601 format (YYYY-MM-DD) */
+        dateOfBirth: string;
+        /** Place of birth (city, state/province, country) */
+        placeOfBirth: string;
+    };
+    /**
+     * Country of residence
+     * ISO 3166-1 alpha-2 country code where the person resides
+     * @example "US"
+     * @example "CA"
+     * @example "GB"
+     */
+    countryOfResidence?: CountryCode;
+}
+
 /**
  * The type of counterparty. Either a natural person or a legal person. If the customer is the same as the counterparty then the counterparty is a self.
  * @public
@@ -2340,6 +3035,131 @@ export declare enum Status {
     BANNED = "banned"
 }
 
+/**
+ * Tax Category
+ * Represents a tax category with its rate and scheme
+ */
+declare interface TaxCategory {
+    /**
+     * Tax category identifier
+     * Uses UBL Tax Category Code standard
+     *
+     * @example TaxCategoryCode.StandardRate
+     * @example TaxCategoryCode.ZeroRated
+     * @example TaxCategoryCode.ExemptFromTax
+     */
+    id: TaxCategoryCode;
+    /**
+     * Tax rate percentage
+     *
+     * @example 20.0 // 20% VAT
+     * @example 0.0  // Zero rate
+     */
+    percent: number;
+    /**
+     * Tax scheme identifier
+     * Uses UBL Tax Scheme Code standard
+     *
+     * @example TaxSchemeCode.ValueAddedTax
+     * @example TaxSchemeCode.GoodsAndServicesTax
+     * @example TaxSchemeCode.SalesTax
+     */
+    taxScheme: TaxSchemeCode | string;
+}
+
+/**
+ * UBL Tax Category Code standard (UN/ECE 5305 Tax Category Code)
+ * Based on UN/CEFACT and EU tax categories
+ *
+ * @see {@link http://docs.oasis-open.org/ubl/os-UBL-2.1/cl/gc/default/TaxCategory-2.1.gc | UBL Tax Category Codes}
+ * @see {@link https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/ | PEPPOL BIS 3.0 Tax Category Codes}
+ */
+declare enum TaxCategoryCode {
+    StandardRate = "S",
+    ZeroRated = "Z",
+    ExemptFromTax = "E",
+    VATReverseCharge = "AE",
+    FreeExportItem = "G",
+    OutsideScopeOfTax = "O",
+    VATExemptIntraCommunity = "K",
+    CanaryIslandsIndirectTax = "L",
+    CeutaMelillaTax = "M",
+    HigherRate = "H",
+    LowerRate = "AA",
+    TransferredVAT = "B",
+    MixedTaxRate = "A",
+    ExemptForResale = "AB",
+    VATReverseChargeAlt = "AC",
+    VATExemptIntraCommunityAlt = "AD",
+    ExemptFromTaxDeprecated = "C",
+    ExemptArticle309 = "D"
+}
+
+/**
+ * UBL Tax Scheme Code standard (UN/ECE 5305 Tax Type Code)
+ * Based on UN/CEFACT tax types
+ *
+ * @see {@link http://docs.oasis-open.org/ubl/os-UBL-2.1/cl/gc/default/TaxScheme-2.1.gc | UBL Tax Scheme Codes}
+ */
+declare enum TaxSchemeCode {
+    ProfitTax = "AAA",
+    CorporateIncomeTax = "AAB",
+    PersonalIncomeTax = "AAC",
+    SocialSecurityTax = "AAD",
+    PropertyTax = "AAE",
+    InheritanceTax = "AAF",
+    GiftTax = "AAG",
+    CapitalGainsTax = "AAH",
+    WealthTax = "AAI",
+    StampDuty = "AAJ",
+    ConsumptionTax = "CST",
+    CustomsDuty = "CUS",
+    EnvironmentalTax = "ENV",
+    ExciseTax = "EXC",
+    ExportTax = "EXP",
+    FreightTax = "FRT",
+    GoodsAndServicesTax = "GST",
+    ImportTax = "IMP",
+    OtherTax = "OTH",
+    SalesTax = "SAL",
+    TurnoverTax = "TOT",
+    ValueAddedTax = "VAT"
+}
+
+/**
+ * Tax Subtotal
+ * Breakdown of taxes by category
+ */
+declare interface TaxSubtotal {
+    /**
+     * Amount subject to this tax
+     */
+    taxableAmount: number;
+    /**
+     * Tax amount for this category
+     */
+    taxAmount: number;
+    /**
+     * Tax category information
+     */
+    taxCategory: TaxCategory;
+}
+
+/**
+ * Tax Total
+ * Aggregate tax information for the invoice
+ */
+declare interface TaxTotal {
+    /**
+     * Total tax amount for the invoice
+     */
+    taxAmount: number;
+    /**
+     * Breakdown of taxes by category
+     */
+    taxSubtotal?: TaxSubtotal[];
+}
+
 /**
  * The theme of the Notabene SDK
  * @public
@@ -2549,6 +3369,43 @@ declare type TransliterationMethodCode = 'arab' | 'aran' | 'armn' | 'cyrl' | 'de
 
  */ export declare type TravelAddress = `ta${string}`;
 
+/**
+ * UBL Unit of Measure Code standard
+ * Based on UN/CEFACT code list
+ *
+ * @see {@link http://docs.oasis-open.org/ubl/os-UBL-2.1/cl/gc/default/UnitOfMeasureCode-2.1.gc | UBL Unit of Measure Codes}
+ */
+declare enum UnitCode {
+    Kilogram = "KGM",
+    Gram = "GRM",
+    Milligram = "MGM",
+    Tonne = "TNE",
+    Liter = "LTR",
+    Milliliter = "MLT",
+    CubicMillimeter = "MMQ",
+    CubicCentimeter = "CMQ",
+    CubicDecimeter = "DMQ",
+    CubicMeter = "MTQ",
+    Millimeter = "MMT",
+    Centimeter = "CMT",
+    Decimeter = "DMT",
+    Meter = "MTR",
+    Kilometer = "KMT",
+    SquareMeter = "MTK",
+    Each = "EA",
+    Piece = "PCE",
+    NumberOfPairs = "NPR",
+    Second = "SEC",
+    Minute = "MIN",
+    Hour = "HUR",
+    Day = "DAY",
+    Week = "WEE",
+    Month = "MON",
+    Year = "ANN",
+    KilowattHour = "KWH",
+    NumberOfArticles = "NAR"
+}
+
 /**
  * Message type for updating component state and configuration from host application
  *
@@ -2576,6 +3433,7 @@ export declare type UpdateValue<T, O> = {
 
 /**
  * A Uniform Resource Identifier
+ * @remarks This type will be narrowed to `` `${string}:${string}` `` in the next major release.
  * @public
  */
 declare type URI = string;