@fin.cx/einvoice 9.0.0 → 10.0.1

package/dist_ts/formats/utils/seller.identifier.d.ts

@@ -0,0 +1,46 @@
+import type { TAccountingDoc } from '../../interfaces/common.js';
+/**
+ * The official text of EN 16931 BR-CO-26 (CEN/TC 434 EN 16931 validation
+ * artefacts 1.3.16, fatal in UBL and CII)
+ */
+export declare const BR_CO_26_TEXT = "In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present.";
+/**
+ * Whether the seller of a UBL document meets BR-CO-26, as the CEN artefacts
+ * check it on `cac:AccountingSupplierParty`: a VAT identifier (BT-31, a
+ * `cac:PartyTaxScheme` with the scheme VAT), a seller identifier (BT-29, a
+ * `cac:PartyIdentification` whose scheme is not SEPA) or a legal registration
+ * identifier (BT-30, `cac:PartyLegalEntity/cbc:CompanyID`). A document without
+ * a seller party is not checked; BR-06 and BR-08 report that.
+ * @param doc The UBL document
+ */
+export declare const ublSellerMeetsBrCo26: (doc: Document) => boolean;
+/**
+ * Whether the seller of a CII document meets BR-CO-26, as the CEN artefacts
+ * check it on `ram:SellerTradeParty`: a seller identifier (BT-29, `ram:ID` or
+ * `ram:GlobalID`), a legal registration identifier (BT-30,
+ * `ram:SpecifiedLegalOrganization/ram:ID`) or a VAT identifier (BT-31,
+ * `ram:SpecifiedTaxRegistration/ram:ID` with the scheme VA).
+ * @param doc The CII document
+ */
+export declare const ciiSellerMeetsBrCo26: (doc: Document) => boolean;
+/**
+ * Whether the seller of an envelope states an identifier BR-CO-26 accepts:
+ * the VAT identifier (BT-31, `registrationDetails.vatId`), the legal
+ * registration identifier (BT-30, `registrationDetails.registrationId`) or a
+ * seller identifier (BT-29), which a decoded UBL document keeps in the
+ * party's `additionalIdentifiers`. A tax number (BT-32) is none of them.
+ * @param accountingDoc The document
+ */
+export declare const envelopeSellerMeetsBrCo26: (accountingDoc: Pick<TAccountingDoc, "from">) => boolean;
+/**
+ * Refuses a written document whose seller fails BR-CO-26, naming the rule; no
+ * identifier is put in place of a missing one. The seller states its VAT
+ * identifier (`registrationDetails.vatId`, BT-31) or its legal registration
+ * identifier (`registrationDetails.registrationId`, BT-30); a tax number
+ * (BT-32) alone does not identify it. A seller identifier (BT-29) is written
+ * from the party's `additionalIdentifiers` (no typed field in the envelope).
+ * @param xml The written document
+ * @param syntax The syntax it is written in
+ * @param targetFormat The format being written
+ */
+export declare const assertSellerIdentified: (xml: string, syntax: "ubl" | "cii", targetFormat: string) => void;

package/dist_ts/formats/utils/seller.identifier.js

@@ -0,0 +1,78 @@
+import { EInvoiceFormatError } from '../../errors.js';
+import { DOMParser, xpath } from '../../plugins.js';
+import { CII_NAMESPACES } from '../cii/cii.types.js';
+import { UBL_NAMESPACES } from '../ubl/ubl.types.js';
+import { getPartyIdentifiers } from './party.identifier.js';
+/**
+ * The official text of EN 16931 BR-CO-26 (CEN/TC 434 EN 16931 validation
+ * artefacts 1.3.16, fatal in UBL and CII)
+ */
+export const BR_CO_26_TEXT = 'In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present.';
+const ublSelect = xpath.useNamespaces({ cac: UBL_NAMESPACES.CAC, cbc: UBL_NAMESPACES.CBC });
+const ciiSelect = xpath.useNamespaces({ rsm: CII_NAMESPACES.RSM, ram: CII_NAMESPACES.RAM });
+const nodesOf = (result) => (Array.isArray(result) ? result : []);
+/**
+ * Whether the seller of a UBL document meets BR-CO-26, as the CEN artefacts
+ * check it on `cac:AccountingSupplierParty`: a VAT identifier (BT-31, a
+ * `cac:PartyTaxScheme` with the scheme VAT), a seller identifier (BT-29, a
+ * `cac:PartyIdentification` whose scheme is not SEPA) or a legal registration
+ * identifier (BT-30, `cac:PartyLegalEntity/cbc:CompanyID`). A document without
+ * a seller party is not checked; BR-06 and BR-08 report that.
+ * @param doc The UBL document
+ */
+export const ublSellerMeetsBrCo26 = (doc) => {
+    const sellers = nodesOf(ublSelect('/*/cac:AccountingSupplierParty', doc));
+    return sellers.every((seller) => {
+        const vatSchemes = nodesOf(ublSelect('./cac:Party/cac:PartyTaxScheme/cac:TaxScheme/cbc:ID', seller)).filter((node) => (node.textContent ?? '').trim().toUpperCase() === 'VAT');
+        const hasVatIdentifier = vatSchemes.some((scheme) => nodesOf(ublSelect('../../cbc:CompanyID', scheme)).length > 0);
+        const hasSellerIdentifier = nodesOf(ublSelect("./cac:Party/cac:PartyIdentification/cbc:ID[not(@schemeID = 'SEPA')]", seller)).length > 0;
+        const hasLegalRegistration = nodesOf(ublSelect('./cac:Party/cac:PartyLegalEntity/cbc:CompanyID', seller)).length > 0;
+        return hasVatIdentifier || hasSellerIdentifier || hasLegalRegistration;
+    });
+};
+/**
+ * Whether the seller of a CII document meets BR-CO-26, as the CEN artefacts
+ * check it on `ram:SellerTradeParty`: a seller identifier (BT-29, `ram:ID` or
+ * `ram:GlobalID`), a legal registration identifier (BT-30,
+ * `ram:SpecifiedLegalOrganization/ram:ID`) or a VAT identifier (BT-31,
+ * `ram:SpecifiedTaxRegistration/ram:ID` with the scheme VA).
+ * @param doc The CII document
+ */
+export const ciiSellerMeetsBrCo26 = (doc) => nodesOf(ciiSelect('//ram:SellerTradeParty', doc)).every((seller) => nodesOf(ciiSelect("./ram:ID | ./ram:GlobalID | ./ram:SpecifiedLegalOrganization/ram:ID | ./ram:SpecifiedTaxRegistration/ram:ID[@schemeID='VA']", seller)).length > 0);
+/**
+ * Whether the seller of an envelope states an identifier BR-CO-26 accepts:
+ * the VAT identifier (BT-31, `registrationDetails.vatId`), the legal
+ * registration identifier (BT-30, `registrationDetails.registrationId`) or a
+ * seller identifier (BT-29), which a decoded UBL document keeps in the
+ * party's `additionalIdentifiers`. A tax number (BT-32) is none of them.
+ * @param accountingDoc The document
+ */
+export const envelopeSellerMeetsBrCo26 = (accountingDoc) => {
+    const seller = accountingDoc.from;
+    if (!seller) {
+        return true;
+    }
+    const details = seller.registrationDetails;
+    const hasSellerIdentifier = getPartyIdentifiers(seller).some((identifier) => identifier.scheme?.toUpperCase() !== 'SEPA');
+    return Boolean(details?.vatId?.trim() || details?.registrationId?.trim() || hasSellerIdentifier);
+};
+const writtenParser = new DOMParser();
+/**
+ * Refuses a written document whose seller fails BR-CO-26, naming the rule; no
+ * identifier is put in place of a missing one. The seller states its VAT
+ * identifier (`registrationDetails.vatId`, BT-31) or its legal registration
+ * identifier (`registrationDetails.registrationId`, BT-30); a tax number
+ * (BT-32) alone does not identify it. A seller identifier (BT-29) is written
+ * from the party's `additionalIdentifiers` (no typed field in the envelope).
+ * @param xml The written document
+ * @param syntax The syntax it is written in
+ * @param targetFormat The format being written
+ */
+export const assertSellerIdentified = (xml, syntax, targetFormat) => {
+    const doc = writtenParser.parseFromString(xml, 'application/xml');
+    const meets = syntax === 'ubl' ? ublSellerMeetsBrCo26(doc) : ciiSellerMeetsBrCo26(doc);
+    if (!meets) {
+        throw new EInvoiceFormatError(`BR-CO-26: ${BR_CO_26_TEXT} The seller states none of them: set from.registrationDetails.vatId (BT-31) or .registrationId (BT-30), or give the seller a seller identifier (BT-29) in from.additionalIdentifiers, where a decoded document keeps it; a tax number (BT-32, .taxNumber) does not identify the seller`, { targetFormat, unsupportedFeatures: ['BR-CO-26'] });
+    }
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsbGVyLmlkZW50aWZpZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9mb3JtYXRzL3V0aWxzL3NlbGxlci5pZGVudGlmaWVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBQ3RELE9BQU8sRUFBRSxTQUFTLEVBQUUsS0FBSyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDcEQsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ3JELE9BQU8sRUFBRSxjQUFjLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUNyRCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUU1RDs7O0dBR0c7QUFDSCxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQ3hCLHlNQUF5TSxDQUFDO0FBRTVNLE1BQU0sU0FBUyxHQUFHLEtBQUssQ0FBQyxhQUFhLENBQUMsRUFBRSxHQUFHLEVBQUUsY0FBYyxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsY0FBYyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7QUFDNUYsTUFBTSxTQUFTLEdBQUcsS0FBSyxDQUFDLGFBQWEsQ0FBQyxFQUFFLEdBQUcsRUFBRSxjQUFjLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxjQUFjLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztBQUM1RixNQUFNLE9BQU8sR0FBRyxDQUFDLE1BQThCLEVBQVUsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztBQUVsRzs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sQ0FBQyxNQUFNLG9CQUFvQixHQUFHLENBQUMsR0FBYSxFQUFXLEVBQUU7SUFDN0QsTUFBTSxPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxnQ0FBZ0MsRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBQzFFLE9BQU8sT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLE1BQU0sRUFBRSxFQUFFO1FBQzlCLE1BQU0sVUFBVSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMscURBQXFELEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQ3pHLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxXQUFXLElBQUksRUFBRSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsV0FBVyxFQUFFLEtBQUssS0FBSyxDQUNsRSxDQUFDO1FBQ0YsTUFBTSxnQkFBZ0IsR0FBRyxVQUFVLENBQUMsSUFBSSxDQUN0QyxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxxQkFBcUIsRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQ3pFLENBQUM7UUFDRixNQUFNLG1CQUFtQixHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMscUVBQXFFLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDO1FBQ3pJLE1BQU0sb0JBQW9CLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxnREFBZ0QsRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUM7UUFDckgsT0FBTyxnQkFBZ0IsSUFBSSxtQkFBbUIsSUFBSSxvQkFBb0IsQ0FBQztJQUN6RSxDQUFDLENBQUMsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUVGOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLENBQUMsTUFBTSxvQkFBb0IsR0FBRyxDQUFDLEdBQWEsRUFBVyxFQUFFLENBQzdELE9BQU8sQ0FBQyxTQUFTLENBQUMsd0JBQXdCLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQ3JELENBQUMsTUFBTSxFQUFFLEVBQUUsQ0FDVCxPQUFPLENBQ0wsU0FBUyxDQUNQLDZIQUE2SCxFQUM3SCxNQUFNLENBQ1AsQ0FDRixDQUFDLE1BQU0sR0FBRyxDQUFDLENBQ2YsQ0FBQztBQUVKOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLENBQUMsTUFBTSx5QkFBeUIsR0FBRyxDQUFDLGFBQTJDLEVBQVcsRUFBRTtJQUNoRyxNQUFNLE1BQU0sR0FBRyxhQUFhLENBQUMsSUFBSSxDQUFDO0lBQ2xDLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNaLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUNELE1BQU0sT0FBTyxHQUFHLE1BQU0sQ0FBQyxtQkFBbUIsQ0FBQztJQUMzQyxNQUFNLG1CQUFtQixHQUFHLG1CQUFtQixDQUFDLE1BQU0sQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLFVBQVUsRUFBRSxFQUFFLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxXQUFXLEVBQUUsS0FBSyxNQUFNLENBQUMsQ0FBQztJQUMxSCxPQUFPLE9BQU8sQ0FBQyxPQUFPLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxJQUFJLE9BQU8sRUFBRSxjQUFjLEVBQUUsSUFBSSxFQUFFLElBQUksbUJBQW1CLENBQUMsQ0FBQztBQUNuRyxDQUFDLENBQUM7QUFFRixNQUFNLGFBQWEsR0FBRyxJQUFJLFNBQVMsRUFBRSxDQUFDO0FBRXRDOzs7Ozs7Ozs7O0dBVUc7QUFDSCxNQUFNLENBQUMsTUFBTSxzQkFBc0IsR0FBRyxDQUFDLEdBQVcsRUFBRSxNQUFxQixFQUFFLFlBQW9CLEVBQVEsRUFBRTtJQUN2RyxNQUFNLEdBQUcsR0FBRyxhQUFhLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxpQkFBaUIsQ0FBQyxDQUFDO0lBQ2xFLE1BQU0sS0FBSyxHQUFHLE1BQU0sS0FBSyxLQUFLLENBQUMsQ0FBQyxDQUFDLG9CQUFvQixDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxvQkFBb0IsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUN2RixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDWCxNQUFNLElBQUksbUJBQW1CLENBQzNCLGFBQWEsYUFBYSx3UkFBd1IsRUFDbFQsRUFBRSxZQUFZLEVBQUUsbUJBQW1CLEVBQUUsQ0FBQyxVQUFVLENBQUMsRUFBRSxDQUNwRCxDQUFDO0lBQ0osQ0FBQztBQUNILENBQUMsQ0FBQyJ9

package/dist_ts/formats/utils/stated.values.d.ts

@@ -0,0 +1,80 @@
+import type { IEInvoiceStatedValues } from '../../interfaces/stated.values.js';
+import type { IDocumentTotals } from './document.totals.js';
+/** A stated value that is no decimal number, by business term and the text found */
+export interface IStatedValueProblem {
+    businessTerm: string;
+    text: string;
+}
+/**
+ * The message for a stated amount that is no decimal number, as the paid
+ * amount's has been: "The paid amount (BT-113) is no decimal number: …"
+ * @param problem The problem
+ */
+export declare const statedValueProblemMessage: (problem: IStatedValueProblem) => string;
+/** The stated values of a document, and the stated amounts that are no number */
+export interface IStatedValuesRead {
+    values: IEInvoiceStatedValues;
+    problems: IStatedValueProblem[];
+    /** How many VAT totals (BT-110) in the document currency the document states; BR-CO-15 asks for exactly one */
+    documentCurrencyTaxTotals?: number;
+    /** Each `cac:TaxTotal` of a UBL document with its tax amount and the tax amounts of its own subtotals, which BR-CO-14 compares */
+    ublTaxTotals?: Array<{
+        taxAmount?: number;
+        subtotalTaxAmounts: Array<number | undefined>;
+    }>;
+}
+/** A finding on stated values: the rule, its official text and where it applies */
+export interface IStatedValueFinding {
+    ruleId: string;
+    message: string;
+    location: string;
+}
+/**
+ * Reads the stated values of a UBL invoice or credit note: the document totals
+ * (`cac:LegalMonetaryTotal`, BT-106 to BT-115, the VAT total `cac:TaxTotal/cbc:TaxAmount`
+ * in the document currency for BT-110 and in the VAT accounting currency for
+ * BT-111), the VAT breakdown (`cac:TaxSubtotal`, BT-116 to BT-121), the line
+ * amounts (BT-126, BT-131, BT-151, BT-152) and the document level allowances
+ * and charges (`cac:AllowanceCharge`, BT-92 to BT-105)
+ * @param doc The UBL document
+ */
+export declare const readUblStatedValues: (doc: Document) => IStatedValuesRead;
+/**
+ * Reads the stated values of a CII (D16B) document: the document totals of the
+ * header settlement (`ram:SpecifiedTradeSettlementHeaderMonetarySummation`,
+ * BT-106 to BT-115, `ram:TaxTotalAmount` in the invoice currency for BT-110 and
+ * in the VAT accounting currency for BT-111), the VAT breakdown (the header
+ * `ram:ApplicableTradeTax`, BT-116 to BT-121), the line amounts (BT-126,
+ * BT-131, BT-151, BT-152) and the document level allowances and charges (the
+ * header `ram:SpecifiedTradeAllowanceCharge`, BT-92 to BT-105)
+ * @param doc The CII document
+ */
+export declare const readCiiStatedValues: (doc: Document) => IStatedValuesRead;
+/**
+ * Checks the stated values of a document against each other as the EN 16931
+ * rules BR-CO-10 to BR-CO-17 do in the CEN artefacts 1.3.16: each sum rounded
+ * to two decimals, BR-CO-17 with the artefacts' tolerance of one unit (UBL
+ * strictly within it, CII up to it). A rule whose amounts the document does
+ * not state is not checked; the rules on the presence of the totals (BR-12 to
+ * BR-15) report that.
+ * @param read The stated values read from the document
+ * @param syntax The document's syntax
+ */
+export declare const findStatedValueDisagreements: (read: IStatedValuesRead, syntax: "ubl" | "cii") => IStatedValueFinding[];
+/** The package's code for a stated value the envelope computes differently */
+export declare const STATED_VALUE_DIFFERS_CODE = "EINVOICE-STATED-DIFFERS";
+/**
+ * The stated values of a loaded document that the envelope's computation
+ * (`computeDocumentTotals`, what `totalNet`, `totalVat`, `totalGross` and the
+ * encoders give) does not reproduce: the totals BT-106, BT-109, BT-110,
+ * BT-112 and BT-115, each line's net amount (BT-131) and VAT category
+ * (BT-151), and each VAT breakdown's category, rate and amounts (BG-23). No
+ * EN 16931 rule is broken by such a difference, so it is the package's own
+ * finding: the envelope has no document or line allowances and charges and no
+ * price base quantity, and every line is standard rated or reverse charge.
+ * Neither value is changed.
+ * @param values The stated values
+ * @param totals The envelope's computation
+ * @param paidAmount The envelope's paid amount (BT-113)
+ */
+export declare const findEnvelopeDifferences: (values: IEInvoiceStatedValues, totals: IDocumentTotals, paidAmount: number | undefined) => IStatedValueFinding[];