feat(tools): preliminary peppol invoice generation

simsustech · Dec 6, 2024 · a5da5f3 · a5da5f3
1 parent 04f7f11
commit a5da5f3
Show file tree

Hide file tree

Showing 3 changed files with 208 additions and 21 deletions.
diff --git a/packages/tools/package.json b/packages/tools/package.json
@@ -38,6 +38,7 @@
     "vue-eslint-parser": "^9.4.3"
   },
   "dependencies": {
+    "@modular-api/fastify-checkout": "^0.4.11",
     "@rgrove/parse-xml": "^4.2.0",
     "fast-xml-parser": "^4.5.0",
     "handlebars": "^4.7.8",

diff --git a/packages/tools/src/peppol/index.ts b/packages/tools/src/peppol/index.ts
@@ -0,0 +1,203 @@
+import type {
+  Invoice,
+  InvoiceLine,
+  InvoiceSurcharge
+} from '@modular-api/fastify-checkout'
+
+interface Peppol {
+  endPointId: string
+}
+
+export const createPeppolInvoice = ({
+  invoice,
+  supplier,
+  customer
+}: {
+  invoice: Invoice
+  supplier: Peppol
+  customer: Peppol
+}) => `
+<?xml version="1.0" encoding="UTF-8"?>
+<Invoice xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
+    xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
+    xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">
+    <cbc:CustomizationID>urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0</cbc:CustomizationID>
+    <cbc:ProfileID>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</cbc:ProfileID>
+    <cbc:ID>${invoice.uuid}</cbc:ID>
+    <cbc:IssueDate>${invoice.date}</cbc:IssueDate>
+    <cbc:DueDate>${invoice.dueDate}</cbc:DueDate>
+    <cbc:InvoiceTypeCode>380</cbc:InvoiceTypeCode>
+    <cbc:DocumentCurrencyCode>${invoice.currency}</cbc:DocumentCurrencyCode>
+    <cbc:BuyerReference>${invoice.projectId}</cbc:BuyerReference>
+    <cac:AccountingSupplierParty>
+        <cac:Party>
+            <cbc:EndpointID schemeID="0088">${supplier.endPointId}</cbc:EndpointID>
+            <cac:PostalAddress>
+                <cbc:StreetName>${invoice.companyDetails.address}</cbc:StreetName>
+                <cbc:CityName>${invoice.companyDetails.city}</cbc:CityName>
+                <cbc:PostalZone>${invoice.companyDetails.postalCode}</cbc:PostalZone>
+                <cac:Country>
+                    <cbc:IdentificationCode>${invoice.companyDetails.country}</cbc:IdentificationCode>
+                </cac:Country>
+            </cac:PostalAddress>
+            <cac:PartyTaxScheme>
+                <cbc:CompanyID>${invoice.companyDetails.vatIdNumber}</cbc:CompanyID>
+                <cac:TaxScheme>
+                    <cbc:ID>VAT</cbc:ID>
+                </cac:TaxScheme>
+            </cac:PartyTaxScheme>
+            <cac:PartyLegalEntity>
+                <cbc:RegistrationName>${invoice.companyDetails.name}</cbc:RegistrationName>
+                <cbc:CompanyID>${invoice.companyDetails.cocNumber}</cbc:CompanyID>
+            </cac:PartyLegalEntity>
+        </cac:Party>
+    </cac:AccountingSupplierParty>
+    <cac:AccountingCustomerParty>
+        <cac:Party>
+            <cbc:EndpointID schemeID="0002">${customer.endPointId}</cbc:EndpointID>
+            <cac:PostalAddress>
+                <cbc:StreetName>${invoice.clientDetails.address}</cbc:StreetName>
+                <cbc:CityName>${invoice.clientDetails.city}</cbc:CityName>
+                <cbc:PostalZone>${invoice.clientDetails.postalCode}</cbc:PostalZone>
+                <cac:Country>
+                    <cbc:IdentificationCode>${invoice.clientDetails.country}</cbc:IdentificationCode>
+                </cac:Country>
+            </cac:PostalAddress>
+            <cac:PartyTaxScheme>
+                <cbc:CompanyID>${invoice.clientDetails.vatIdNumber}</cbc:CompanyID>
+                <cac:TaxScheme>
+                    <cbc:ID>VAT</cbc:ID>
+                </cac:TaxScheme>
+            </cac:PartyTaxScheme>
+            <cac:PartyLegalEntity>
+                <cbc:RegistrationName>${invoice.clientDetails.companyName}</cbc:RegistrationName>
+                <cbc:CompanyID schemeID="0183">${invoice.clientDetails.cocNumber}</cbc:CompanyID>
+            </cac:PartyLegalEntity>
+            <cac:Contact>
+                <cbc:Name>${invoice.clientDetails.contactPersonName}</cbc:Name>
+                <cbc:ElectronicMail>${invoice.clientDetails.email}</cbc:ElectronicMail>
+            </cac:Contact>
+        </cac:Party>
+    </cac:AccountingCustomerParty>
+  
+    <cac:PaymentMeans>
+        <cbc:PaymentMeansCode name="Credit transfer">30</cbc:PaymentMeansCode>
+        <cbc:PaymentID>${invoice.uuid}</cbc:PaymentID>
+        <cac:PayeeFinancialAccount>
+            <cbc:ID>${invoice.companyDetails.iban}</cbc:ID>
+            <cbc:Name>${invoice.companyDetails.name}</cbc:Name>
+            <cac:FinancialInstitutionBranch>
+                <cbc:ID>${invoice.companyDetails.bic}</cbc:ID>
+            </cac:FinancialInstitutionBranch>
+        </cac:PayeeFinancialAccount>
+    </cac:PaymentMeans>
+    <cac:PaymentTerms>
+        <cbc:Note>${invoice.notes}</cbc:Note>
+    </cac:PaymentTerms>
+    ${formatSurcharges({ surcharges: invoice.surcharges, currency: invoice.currency })}
+    ${formatInvoiceLines({ lines: invoice.lines, currency: invoice.currency })}
+
+    <cac:LegalMonetaryTotal>
+        <cbc:LineExtensionAmount currencyID="EUR">${formatAmount(invoice.totalIncludingTax)}</cbc:LineExtensionAmount>
+        <cbc:TaxExclusiveAmount currencyID="EUR">${formatAmount(invoice.totalExcludingTax)}</cbc:TaxExclusiveAmount>
+        <cbc:TaxInclusiveAmount currencyID="EUR">${formatAmount(invoice.taxSummary.reduce((acc, cur) => (acc += cur.tax), 0))}</cbc:TaxInclusiveAmount>
+        <cbc:ChargeTotalAmount currencyID="EUR">${formatAmount(invoice.surcharges?.reduce((acc, cur) => (acc += cur.listPriceIncludingTax), 0))}</cbc:ChargeTotalAmount>
+        <cbc:PrepaidAmount currencyID="${invoice.currency}">${formatAmount(invoice.amountPaid)}</cbc:PrepaidAmount>
+        <cbc:PayableAmount currencyID="EUR">${formatAmount(invoice.amountDue)}</cbc:PayableAmount>
+    </cac:LegalMonetaryTotal>
+
+        <cac:TaxTotal>
+        <cbc:TaxAmount currencyID="EUR">${invoice.taxSummary.reduce((acc, cur) => (acc += cur.tax), 0)}</cbc:TaxAmount>
+        ${formatTaxSubTotals({ taxSummary: invoice.taxSummary, currency: invoice.currency })}
+    </cac:TaxTotal>
+</Invoice>`
+
+const formatSurcharges = ({
+  surcharges,
+  currency
+}: {
+  surcharges: InvoiceSurcharge[] | null
+  currency: Invoice['currency']
+}) =>
+  surcharges?.map(
+    (surcharge) =>
+      `
+    <cac:AllowanceCharge>
+            <cbc:ChargeIndicator>true</cbc:ChargeIndicator>
+            <cbc:AllowanceChargeReason>${surcharge.description}</cbc:AllowanceChargeReason>
+            <cbc:Amount currencyID="${currency}">${formatAmount(surcharge.listPriceIncludingTax)}</cbc:Amount>
+            <cac:TaxCategory>
+                <cbc:ID>S</cbc:ID>
+                <cbc:Percent>${surcharge.taxRate}</cbc:Percent>
+                <cac:TaxScheme>
+                    <cbc:ID>VAT</cbc:ID>
+                </cac:TaxScheme>
+            </cac:TaxCategory>
+        </cac:AllowanceCharge>
+  ` || ''
+  )
+
+const formatInvoiceLines = ({
+  lines,
+  currency
+}: {
+  lines: InvoiceLine[]
+  currency: Invoice['currency']
+}) =>
+  lines?.map(
+    (line, index) => `
+<cac:InvoiceLine>
+    <cbc:ID>${index}</cbc:ID>
+    <cbc:InvoicedQuantity unitCode="H87">${line.quantity}</cbc:InvoicedQuantity>
+    <cbc:LineExtensionAmount currencyID="${currency}">${formatAmount(line.discountedLinePriceIncludingTax)}</cbc:LineExtensionAmount>
+    <cac:OrderLineReference>
+        <cbc:LineID>123</cbc:LineID>
+    </cac:OrderLineReference>
+    <cac:Item>
+        <cbc:Description>${line.description}</cbc:Description>
+        <cac:ClassifiedTaxCategory>
+            <cbc:ID>S</cbc:ID>
+            <cbc:Percent>${line.taxRate}</cbc:Percent>
+            <cac:TaxScheme>
+                <cbc:ID>VAT</cbc:ID>
+            </cac:TaxScheme>
+        </cac:ClassifiedTaxCategory>
+    </cac:Item>
+    <cac:Price>
+        <cbc:PriceAmount currencyID="${currency}">${formatAmount(line.listPrice)}</cbc:PriceAmount>
+         <cac:AllowanceCharge>
+            <cbc:ChargeIndicator>false</cbc:ChargeIndicator>
+            <cbc:Amount>${formatAmount(line.discountIncludingTax)}</cbc:Amount>
+            <cbc:BaseAmount>${formatAmount(line.discountExcludingTax)}</cbc:BaseAmount>
+        </cac:AllowanceCharge>
+    </cac:Price>
+</cac:InvoiceLine>
+`
+  ) || ''
+
+const formatTaxSubTotals = ({
+  taxSummary,
+  currency
+}: {
+  taxSummary: Invoice['taxSummary']
+  currency: Invoice['currency']
+}) =>
+  taxSummary?.map(
+    (tax) => `
+        <cac:TaxSubtotal>
+            <cbc:TaxableAmount currencyID="${currency}"></cbc:TaxableAmount>
+            <cbc:TaxAmount currencyID="EUR">${formatAmount(tax.tax)}</cbc:TaxAmount>
+            <cac:TaxCategory>
+                <cbc:ID>${tax.taxRate}</cbc:ID>
+                <cbc:Percent>${tax.taxRate.toFixed(1)}</cbc:Percent>
+                <cac:TaxScheme>
+                    <cbc:ID>VAT</cbc:ID>
+                </cac:TaxScheme>
+            </cac:TaxCategory>
+        </cac:TaxSubtotal>`
+  )
+
+const formatAmount = (amount: number | null | undefined) => {
+  if (amount) return (amount / 100).toFixed(2)
+  return '0'
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml