Helper functions for UBL generation.
Contains utility functions for calculating totals, formatting values, and generating XML fragments.
Summary
Functions
Generate AllowanceCharge XML for a detail with discount.
Generate BillingReference XML elements.
Generate optional CityName XML element.
Generate Delivery terms XML for invoices.
Escape XML special characters.
Format a Decimal amount as a string with 2 decimal places.
Infer Peppol scheme ID from country code.
Infer tax category from detail, defaulting based on VAT percentage.
Generate PartyLegalEntity XML with optional CompanyID.
Get scheme for a party, using explicit scheme if provided, otherwise inferring from country.
Generate optional PartyTaxScheme XML element for supplier.
Convert a Peppol tax category code to a descriptive atom.
Generate PostalAddress XML with optional elements. Only Country > IdentificationCode is required.
Generate optional PostalZone XML element.
Format street address with optional house number.
Generate optional StreetName XML element.
Generate tax category XML (ID and Percent).
Generate tax category XML with optional exemption fields.
Generate a TaxSubtotal XML element.
Generate tax totals XML for all tax categories.
Calculate UBL-compliant line total for a detail item.
Calculate UBL-compliant totals with proper rounding for Peppol validation.
Extract numeric VAT number (remove country code and non-digits).
Functions
Generate AllowanceCharge XML for a detail with discount.
Generate BillingReference XML elements.
Accepts a list of invoice numbers and generates BillingReference elements.
Generate optional CityName XML element.
Generate Delivery terms XML for invoices.
Escape XML special characters.
Format a Decimal amount as a string with 2 decimal places.
Infer Peppol scheme ID from country code.
Returns the country-specific scheme if known, otherwise returns "0088" (EAN/GLN).
Examples
iex> UblEx.Generator.Helpers.infer_scheme("BE")
"0208"
iex> UblEx.Generator.Helpers.infer_scheme("US")
"0088"Infer tax category from detail, defaulting based on VAT percentage.
If tax_category is explicitly set, use it. Otherwise:
- VAT 6%, 12%, 21% → :standard
- VAT 0% → :zero_rated
Generate PartyLegalEntity XML with optional CompanyID.
Get scheme for a party, using explicit scheme if provided, otherwise inferring from country.
Generate optional PartyTaxScheme XML element for supplier.
Convert a Peppol tax category code to a descriptive atom.
Returns :standard for unknown codes.
Generate PostalAddress XML with optional elements. Only Country > IdentificationCode is required.
Generate optional PostalZone XML element.
Format street address with optional house number.
Generate optional StreetName XML element.
Generate tax category XML (ID and Percent).
Accepts VAT percentage (integer or Decimal) and tax category atom.
Generate tax category XML with optional exemption fields.
Includes TaxExemptionReasonCode and TaxExemptionReason when provided.
Generate a TaxSubtotal XML element.
Generate tax totals XML for all tax categories.
Groups details by VAT percentage and tax category, then generates TaxSubtotal elements. VAT is calculated on the grouped subtotal to avoid rounding errors.
Calculate UBL-compliant line total for a detail item.
Ensures consistency with AllowanceCharge calculations.
Calculate UBL-compliant totals with proper rounding for Peppol validation.
Ensures:
- BR-CO-15: TaxInclusiveAmount = TaxExclusiveAmount + TaxAmount
- BR-CO-10: LineExtensionAmount = Σ InvoiceLine/LineExtensionAmount
- PEPPOL-EN16931-R120: Line net amounts are correctly calculated
VAT is calculated by grouping lines with the same VAT rate, summing their totals, then applying VAT to the sum. This prevents rounding errors from accumulating when multiple lines have the same VAT rate.
Returns a map with:
:subtotal- Sum of all line totals:vat- Sum of all VAT amounts:grand_total- Subtotal + VAT
Extract numeric VAT number (remove country code and non-digits).