unova_factur_x 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d09c11c8d2bfdc9f2d14de6eb7bbd7aee94f46675b929681cb683487fb0a2bb
-  data.tar.gz: de833a261679131412fce8ec11d9925e099107fbd4462c1d2908b3917a467f13
+  metadata.gz: afe65450ac95318d3801d4b6c32354ed59cf54f3cf29ada07341338757298196
+  data.tar.gz: fa80807526a468b386c79d58a1a2e56b591ab12b1bd6d9cc65afccf5c23d9b92
 SHA512:
-  metadata.gz: 44189769adcebd89694313a24d2e6a9bd3a109e99a2c4ac53891a4a2a5c2e55b03427e61434d9c94a182f69f3ac03a1317e0c22d504f2dd302925aa53865524e
-  data.tar.gz: 2b0b0163eee7106f2b1fc00b85eb4328ccc50b87ea4476a7e451b51cdcc2dfe9f952eaca7d8df773ca4d837e064c1406ada894148b9f2369ca0ec0a5185318e2
+  metadata.gz: 3640dca1a01ecd8125e706eae96610791150ff4cfdd98051d3c03eb5d5cfb65ccc42002e2009d1bb843a194b75b34a7982cea004ce3d63c814004153df6598fb
+  data.tar.gz: 7be6c186c292247e77240a17bac801059eaf292cc62bfb4fb4c2c4686521cd0d8cb79f4689b1e3bd23acc0ec69671a8bb9f24ec5462de36c6376b07da42e0a31

data/README.md

@@ -60,7 +60,15 @@ For the expected document hash:
 document_hash = {
   id: "Unique invoice number (BT-1) [REQUIRED]",
   issue_date: "Issue date in YYYYMMDD format (BT-2) [REQUIRED]",
-
+  context: "BT-23 [REQUIRED] Value in (B1: Unpaid products, S1: Unpaid services, M1: Unpaid products and services, B2: Paid products, S2: Paid services, M2: Paid products and services)",
+  
+  # [REQUIRED BLOCK IF BR_FR PROFILE AND IF THE DOCUMENT IS A CREDIT]
+  referenced_invoice: {
+    reference: "Referenced invoice identifier (BT-25) [REQUIRED if block is present]",
+    date: "Referenced invoice issue date in YYYYMMDD format (BT-26) [REQUIRED if block is present]",
+  },
+  
+  # [REQUIRED BLOCK]
   seller: {
     name: "Seller legal name (BT-27) [REQUIRED]",
     legal_id: { # [REQUIRED IF BR_FR PROFILE, OTHERWISE OPTIONAL]
@@ -68,10 +76,10 @@ document_hash = {
       scheme: "Legal registration identifier scheme (ICD), e.g. 0002 for SIREN, 0009 for SIRET (BT-30-1) [REQUIRED IF IDENTIFIER IS PROVIDED]"
     },
     electronic_address: { # [REQUIRED IF BR_FR PROFILE, OTHERWISE OPTIONAL]
-      identifier: "Seller electronic address (e.g. email address or Peppol endpoint) (BT-34) [REQUIRED IF BR_FR PROFILE, OTHERWISE OPTIONAL]",
-      scheme: "Electronic address scheme identifier (EAS code, e.g. EM for email, 0088 for GLN) [REQUIRED IF IDENTIFIER IS PROVIDED]"
+      identifier: "Seller electronic address (e.g. email address or Peppol endpoint) (BT-34) [REQUIRED AS PEPPOL ENDPOINT IF BR_FR PROFILE, OTHERWISE OPTIONAL]",
+      scheme: "Electronic address scheme identifier (EAS code, e.g. EM for email, 0225 for Peppol ID) [REQUIRED IF IDENTIFIER IS PROVIDED]"
     },
-    vat_number: "VAT number including buyer country prefix (e.g. FR123...) (BT-31) [OPTIONAL]",
+    vat_number: "VAT number including seller country prefix (e.g. FR123...) (BT-31) [OPTIONAL]",
     address: {
       line1: "Street address (BT-35) [REQUIRED]",
       line2: "Address complement [OPTIONAL]",
@@ -94,8 +102,8 @@ document_hash = {
       name: "Customer contact name (BT-56) [OPTIONAL]",
     },
     electronic_address: { # [REQUIRED IF BR_FR PROFILE, OTHERWISE OPTIONAL]
-      identifier: "Buyer electronic address (e.g. email address or Peppol endpoint) (BT-49) [REQUIRED IF BR_FR PROFILE, OTHERWISE OPTIONAL]",
-      scheme: "Electronic address scheme identifier (EAS code, e.g. EM for email, 0088 for GLN) (BT-49-1) [REQUIRED IF IDENTIFIER IS PROVIDED]"
+      identifier: "Buyer electronic address (e.g. email address or Peppol endpoint) (BT-49) [REQUIRED AS PEPPOL ENDPOINT IF BR_FR PROFILE, OTHERWISE OPTIONAL]",
+      scheme: "Electronic address scheme identifier (EAS code, e.g. EM for email, 0225 for Peppol ID) (BT-49-1) [REQUIRED IF IDENTIFIER IS PROVIDED]"
     },
     address: {
       line1: "Street address (BT-50) [REQUIRED]",
@@ -181,9 +189,10 @@ document_hash = {
     tax_basis_total_ht: "Total taxable amount (BT-109) [REQUIRED]",
     tax_total: "Total VAT amount (BT-110) [REQUIRED]",
     grand_total_ttc: "Grand total including VAT (BT-112) [REQUIRED]",
-    amount_due: "Amount due for payment (BT-115) [OPTIONAL]",
+    prepaid_amount: "Amount already paid (BT-113) [REQUIRED IF BR_FR PROFILE AND context is B2, S2 or M2]",
+    amount_due: "Amount due for payment (BT-115) [OPTIONAL, REQUIRED AND MUST BE 0 IF BR_FR PROFILE AND context is B2, S2 or M2]",
     # due_date OR description [REQUIRED] if amount_due is defined and positive
-    due_date: "Payment due date in YYYYMMDD format (BT-9)",
+    due_date: "Payment due date in YYYYMMDD format (BT-9) [REQUIRED IF BR_FR PROFILE AND context is B2, S2 or M2]",
     description: "Payment terms (BT-20)"
   },
 
@@ -192,7 +201,7 @@ document_hash = {
   notes: [
     {
       content: "Free-text note content (BT-22) [REQUIRED if block is present]",
-      subject_code: "Note subject code (BT-21), e.g. AAB (early payment discount), PMD (late payment penalties), PMT (fixed recovery compensation) [OPTIONAL, REQUIRED IF BR_FR PROFILE FOR SOME NOTES SUCH AS AAB, PMD AND PMT]"
+      subject_code: "Note subject code (BT-21), e.g. AAB (early payment discount), PMD (late payment penalties), PMT (fixed recovery compensation) [OPTIONAL, REQUIRED IF BR_FR PROFILE WITH THE NOTES AAB, PMD AND PMT]"
     },
   ]
 }

data/lib/unova_factur_x/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UnovaFacturX
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/unova_factur_x/xml_generator.rb

@@ -45,7 +45,7 @@ module UnovaFacturX
     def build_exchanged_document_context(xml)
       xml['rsm'].ExchangedDocumentContext do
         xml['ram'].BusinessProcessSpecifiedDocumentContextParameter do
-          xml['ram'].ID(@type == :credit ? "B2" : "B1") # Business process type identifier, value in (B1, S1, M1, B2, S2, M2, B4, S4, M4, S5, S6, B7, S7) (BT-23)
+          xml['ram'].ID(@document[:context]) # Business process type identifier, value in (B1, S1, M1, B2, S2, M2, B4, S4, M4, S5, S6, B7, S7) (BT-23)
         end
         xml['ram'].GuidelineSpecifiedDocumentContextParameter do
           xml['ram'].ID("urn:cen.eu:en16931:2017") # Identifier of the invoice specification (European EN16931 standard)
@@ -240,6 +240,18 @@ module UnovaFacturX
       end
     end
 
+    def build_referenced_invoice(xml)
+      referenced_invoice = @document[:referenced_invoice]
+      return if referenced_invoice.blank?
+
+      xml['ram'].InvoiceReferencedDocument do
+        xml['ram'].IssuerAssignedID(referenced_invoice[:reference]) # Referenced invoice identifier (BT-25)
+        xml['ram'].FormattedIssueDateTime do
+          xml['qdt'].DateTimeString(referenced_invoice[:date], format: "102") # Referenced invoice issue date (BT-26)
+        end
+      end
+    end
+
     def build_applicable_header_trade_settlement(xml)
       xml['ram'].ApplicableHeaderTradeSettlement do
         payment = @document[:payment_means]
@@ -303,8 +315,11 @@ module UnovaFacturX
           xml['ram'].TaxBasisTotalAmount(totals[:tax_basis_total_ht]) # Total taxable base amount (BT-109)
           xml['ram'].TaxTotalAmount(totals[:tax_total], currencyID: @currency) # Total VAT amount (BT-110)
           xml['ram'].GrandTotalAmount(totals[:grand_total_ttc]) # Total amount including VAT (BT-112)
+          xml['ram'].TotalPrepaidAmount(totals[:prepaid_amount]) if totals[:prepaid_amount].present? # Amount already paid (BT-113)
           xml['ram'].DuePayableAmount(totals[:amount_due]) if totals[:amount_due].present? # Amount remaining to be paid (BT-115)
         end
+
+        build_referenced_invoice(xml)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unova_factur_x
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Rodolphe Limousin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-08 00:00:00.000000000 Z
+date: 2026-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hexapdf