CHANGELOG.md

Change Log

All notable changes to GOBL will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning. See also the GOBL versions documentation site for more details.

[Unreleased]

Removed

• pl-favat-v3: Preceding no longer required when it is a credit note

Added

• eu-en16931-v2017: BR-32 validation requiring taxes on document-level discounts.

Changed

• bill: Invoice.Invert() returns an error if the invoice has the bypass tag.
• num: AmountFromString now limits precision to 18 significant digits.
• tax: Added $defs and $refs to the tax.RegimeCode JSON schema

Fixed

• tax: Fixed Since date comparison to be inclusive
• gr-mydata-v1: Corrected exemption codes 3 and 4 mapping to outside-scope

[v0.308.0] - 2026-02-17

Removed

• pkg/template: removed as no longer used.

Added

• fr-ctc-v1: French CTC Flow 2 B2B e-invoicing addon
• fr: SIREN and SIRET identity types format validation
• org: New note keys: payment-method and payment-term

Changed

• eu-en16931-v2017: Identity normalization now supports type-based identities
• dk: Updated CVR identity to use Type instead of Key

Fixed

• bill: Invoice, Order, Payment, and Delivery now normalize Notes fields
• bill: Invoice and Order now normalize Attachments fields

[v0.307.0] - 2026-01-27

Added

• dk: Added the Danish regime
• de: Added support for NW Steuernummer
• pl-favat-v3: Added Poland FAVAT V3 addon

Fixed

• l10n: UnionDef method HasMemberOn now correctly handles empty codes

[v0.306.0] - 2026-01-19

Changed

• bill: Line and SubLine now normalize negative item prices to quantity.
• org: Item requires zero or positive price.

Added

• head: Link support for category and improved file support.
• pt-saft-v1: Add new exemption codes (M44, M45, M46)

[v0.305.1] - 2026-01-09

Fixed

• eu-en16931-v2017: Allow 0 item prices.

[v0.305.0] - 2026-01-08

Added

• ar-arca-v4: Added initial Argentina ARCA addon.
• eu-en16931-v2017: Added check for negative prices.
• br-nfse-v1: Add extensions for IBS/CBS tax determination (RTC)
• br: Add CBS and IBS tax categories
• gr-mydata-v1: New charge types: fees, stamp duties and other taxes.

Removed

• eu-en16931-v2017: Removed constraint for payment terms in Credit Notes.
• bill: LineDiscount and LineCharge no longer return an error when the amount is 0.

[v0.304.0] - 2025-12-10

Added

• bill: Add replicate logic to payments, orders and deliveries.
• tax: Tags.RemoveTags() method for removing tags from a list.
• es-verifactu-v1: Bill Lines require at least one of the main tax categories.
• org: Item now defines services and goods as predefined options, required by some formats/regimes.
• org: Identity has a scope field for defining where an identity should be used, such as for tax or legal purposes.
• es-sii-v1: Added initial Spain SII addon.

Changed

• bill: Refactor replicate logic to rely on calculations to set default values.

Fixed

• es-verifactu-v1: Simplified invoices no longer require a tax ID.

Removed

• org: Attachment.Name field is no longer required.
• it-sdi-v1: removed IBAN length validation.

[v0.303.0] - 2025-11-17

Added

• org: Identity now has gln as a possible Key.
• eu-en16931-v2017: Identity normalization adds iso scheme codes extension for certain keys.
• ar: Argentine regime
• it-sdi-v1: Add Italian phone number validation and normalization
• it-sdi-v1: Add validation for IBANs.

Removed

• pay: Removed terms.Detail in favour of terms.Notes

Fixed

• eu-en16931-v2017: Remove address constraint for all parties, keep for Supplier and Customer.
• be: Update regex to account for new VAT numbers starting with 1.

[v0.302.1] - 2025-10-31

Fixed

• l10n: union will now check alternative country codes: fixes issue with GR and EL codes in the EU.

[v0.302.0] - 2025-10-29

Added

• co: Add new INC tax defenition.
• sg: Singaporean regime
• tax: keys for GST
• bill: Line with seller property, to be used in Mexico.
• org: DocumentRef supports the schema field.
• se: Swedish regime.
• luhn: package for handling luhn Mod10 calculations.
• br-nfe-v4: added Brazil NF-e addon for NF-e and NFC-e documents
• regimes/ie: Irish regime.

Fixed

• eu-en16931-v2017: fixed issue with payment details when due is zero

Removed

• es-verifactu-v1: validation to prevent forbidden characters in names.
• org: Attachment.data field removed in favour of URL. We don't believe that embedding binary data inside a JSON object is aligned with the objectives of GOBL to be lightweight and easy to use.

Changed

• it-sdi-v1: Updated mapping of exemption (natura) codes to reflect CIUS mapping guide.

[v0.301.0] - 2025-10-03

Added

• it-sdi-v1: added validation for name and persons so that at least one is set.
• eu-en16931-v2017: Add missing scenario for self billing credit notes.
• es-verifactu-v1: validation to prevent forbidden characters in names.

Changed

• eu-en16931-v2017: Add missing Business Rules with labels at implementation level.
• de-xrechnung-v3: Add missing validation from CIUS.
• fr: Add identity validation and normalization.
• it-sdi-v1: Modify address validation to accept postbox.
• bill: support for bypass tag, to prevent billing total calculations (experimental).
• Updated normalizer ordering so that inside fields/objects are processed before the parent object

Removed

• pt: migrations for Zone, no longer needed

Fixed

• pt-saft: minimum exemption note length corrected to 6 characters

[v0.300.2] - 2025-09-18

Added

• org: Item - images field for storing links to images of the item.
• it-sdi-v1: added fund contributions via charges and validation for despatch (delivery documents)
• it: added new tax category for CP to handle code RT06 for retained taxes
• pt-saft-v1: positive quantity validation
• pt-saft-v1: tax rate normalization to prevent rate extension and percent mismatches
• pt-saft-v1: exemption note text length validation

Removed

• es-verifactu-v1: removed preceding validations for credit notes and F3 invoice type

Fixed

• es: IGIC now uses VAT keys
• bill: fixed zero-percent handling in charges and discounts

[v0.300.1] - 2025-09-12

Fixed

• gr-mydata-v1: Fix incorrect VAT rate mapping.

[v0.300.0] - 2025-09-11

Fixed

• tax: Combo exempt rate will be migrated to key. Addons need to handle specific migrations.
• pt-saft-v1: fixed exempt rate handling.
• it-sdi-v1: fixed exempt rate handling.

[v0.300.0-rc2] - 2025-09-09

Added

• pt-saft-v1: added extensions to handle integration of documents (other systems, manually issued or recovered)

Changed

• pt: added comprehensive validations to regime
• pt-saft-v1: added comprehensive validations to addon

Fixed

• mx: normalize codes with MX code at the beginning
• es-verifactu-v1: correct N2 operation code scenario

Changed

• cbc: new NormalizeString method to help clean texts used throughout GOBL to trim whitespace and remove invalid or nil UTF-8 characters.
• tax: Combo: removing migration of exempt rate field to key, so as not to make assumptions about manually assigned extensions.
• pl: moved to new addon pl-favat-v2 - only basic implementation at this time to remove restrictions on regime, expect more changes in future.

[v0.300.0-rc1] - 2025-09-02

IMPORTANT: Significant refactor of tax combo handling with the addition of tax "keys" that help identify the sub-classification of a tax, specifically VAT, ensuring that they can be correctly mapped.

Unmarshalling JSON GOBL documents will be migrated automatically to the new structure, including any rate tags or addon extensions, but consuming may require changes if using the tax combo rate property.

Added

• tax: Combo now includes a key field with VAT values taken from the EN16931. We've tried to normalize all common use-cases from the rate field, so no changes should be required.
• br: added retained taxes CSLL, INSS and IRRF
• tax: added support for informative tax categories that will be calculated and reported but will not affect the invoice totals.
• br: made ISS an informative tax

Fixed

• fr: handle exception cases in Tax Identity Codes.

Changed

• tax: renamed standard rate to general to more closely reflect usage and differentiate from new standard key using the Combo.
• pt-saft-v1: moved exemption notes to line-level and added validations

[v0.220.6] - 2025-08-12

Changed

• org.Party: avoid panic when regime's normalizer is not present
• br: set missing normalizer in regime definition
• tax: Normalizers() method in RegimeDef

Added

• br: tax identity validation for CPF code.

[v0.220.5] - 2025-07-21

Changed

• pt-saft-v1: restore generic notes for M99 and M19 exemption codes for backwards compatibility.

[v0.220.4] - 2025-07-17

Added

• es: tax identity codes for nationals will be zero padded.

Changed

• es: refactored tax identity code checks for easier re-use, removed old specific errors and replaces DetermineTaxCodeType method with TaxIdentityKey.
• es: removed old tax identity zone check.

Fixes

• bill: Correcting ConvertInto to handle item level currency values.

[v0.220.3] - 2025-07-15

Added

• tax: Identity#InEU method for checking if Identity is in the EU on a specific date.

Changed

• es-verifactu-v1: refining copy related to identity handling.

[v0.220.2] - 2025-07-14

Added

• co-dian-v2: added co-dian-fiscal-responsibility extension for suppliers and customers

Changed

• es-verifactu-v1:
  • Refining customer validation to support Tax ID or identity with extension.
  • New replacement tag to use when simplified invoices are replaced with a complete version.
  • Setting credit-note default document type to R1 if not set in correction process.
  • Improved extension documentation and usage.

[v0.220.1] - 2025-07-09

Fixes

• tax: Correcting $tags JSON Schema properties from OneOf to AnyOf.

[v0.220.0] - 2025-07-09

Added

• bill: Ordering now includes an issuer field.
• es/verifactu: Support for es-verifactu-simplified-art7273 and es-verifactu-issuer-type extensions.

Changed

• bill: All invoices will now have a default set of $tags that can be used.

[v0.219.0] - 2025-07-08

Changed

• es-verifactu-v1: []*org.Note validation will check the note's length if key=general
• pt-saft-v1: adapted and additional validations for the new bill.Payment structure
• pt-saft-v1: updated pt-exemption-code extension list and related scenarios to use the texts complaint with the regulations.
• fr-choruspro: bill.Line quantity field will now be normalized to four decimal places.

Added

• mx-cfdi-v4: Validate price greater than 0.
• it-sdi-v1: Validate names and addresses contain only latin characters as required by SDI.
• it-sdi-v1: Payment means now support online key as a card payment.
• org: Unit additional standard units.
• es/verifactu: map identity keys for specific codes.
• org: Person: new key, addresses, and identities properties.

[v0.218.0] - 2025-06-12

Changed

• bill: PaymentLine will recalculate tax totals based on proportional amounts paid per-line, alongside the total advances and amount due.
• bill: PaymentLine removed the debit and credit fields which were confusing, especially alongside the advances. Please now use the refund flag.
• bill: Payment will check the line document's currency and require an exchange rate if different from the document's.
• bill: Payment tax field is no longer supported, we assume convertors will deal with tax for each payment line.
• fr: Removed unnecessary length check when validating the SIREN.

Added

• bill: PaymentLine includes a refund boolean to indicate flow of funds, and impacts the Payment's total potentially making it negative.
• org: DocumentRef now includes a payable property.
• bill: PaymentLine includes description, installment, payable, advances, due, and tax properties.
• mx-cfdi-v4: Define payment method in document.
• fr-choruspro-v1: Created addon for Chorus Pro to handle invoice types and identity schemes

[v0.217.1] - 2025-06-02

Fixed

• tax: Simple Normalize method support.

[v0.217.0] - 2025-06-02

Changed

• mx: updated examples to use postcodes in the central timezone (most common)
• cbc: Code: allow , (comma) as separator.
• org: Telephone normalized and format restrictions removed.

Fixed

• es-verifactu-v1: only validate presence of tax in preceding rows for corrective types.
• org: normalizing Item Ref field.

[v0.216.3] - 2025-05-20

Changed

• tools: removed as considered too opinionated for other projects using GOBL.
• org: normalize inboxes with the peppol key, splitting participant ID between scheme and code.

Fixed

• cal: JSON Schema pattern for time.

[v0.216.1] - 2025-05-20

Added

• regimes: template.
• tools: explicit dependency for golangci-lint via tools.go.
• CONTRIBUTING.md file.

Changed

• num: improved MakePercentage documentation.

Fixed

• es: small typo in the description for simplified scheme description.
• it-sdi-v1: Do not enforce Italian postcode format on foreign addresses.

[v0.216.0] - 2025-05-12

Added

• bill.Line: Add extensions to line.
• it-ticket-v1: Stamp key for document number added and void document number.
• it-ticket-v1: Extension for customer lottery code.
• it-ticket-v1: Add line extension for line ID that will be issued by the AdE.
• it-ticket-v1: Add corrections to addon with document number stamp.
• tax: Totals now have public Round method.

Fixed

• bill: Rounding before payment calculations.
• tax: Rounding bug in totals calculations.
• it-sdi-v1 : Removed isItalian check on customer address

[v0.215.0] - 2025-04-28

Changed

• bill: Totals now separates retained from indirect taxes, with a new RetainedTax field applied between the TotalWithTax and Payable amounts.
• tax: Totals will now calculate sum with separate Retained amount.

Added

• bill: Support for issue_time field, which will be updated automatically if provided with a zero value. Nil issue times will always be ignored.
• bill: Payment will now set issue date automatically, alongside issue time if provided.
• mx-cfdi-v4: Support for "Global" B2C invoice reporting that group together B2C sales into a single document.
• mx-cfdi-v4: Automatically set the issue_time if not already provided.
• tax: ExtensionsRequireAllOrNone validation rule.
• es-verifactu-v1: validation for export exemption codes.
• tax: ExtensionsExcludeCodes validation rule.

Removed

• tax: ExtensionsHas usage should be replaced with ExtensionsRequire validator.

[v0.214.1] - 2025-04-09

Fixed

• es-tbai-v1: removing series presence check

[v0.214.0] - 2025-04-09

Added

• bill: Ordering with cost code for accounting.
• it-sdi-v1: Normalize address codes with 0 padding.
• eu-en16931-v2017: Validating inboxes.
• org: Inbox now with scheme field.

Fixed

• dsig: Upgraded signing packages.

[v0.213.0] - 2025-03-25

Added

• it-sdi-v1: validation for non latin and latin-1 characters in item names.
• pt-saft-v1: support for stock movements (from bill.Delivery) and work documents (from bill.Invoice and bill.Order)
• tax: Regime Definition now supports a primary TaxScheme property for usage in converting to other formats.
• tax: Identity now supports an override Scheme field and GetScheme method that will fallback to the Regime's tax scheme default.

Changed

• bill: line rounding will now check for nil item and nil item price.
• bill: code field now "recommended" in Order, Delivery, Invoice, & Payment schemas, but should not raise JSON Schema warnings. Validation will continue to fail when signing.
• bill: more sub-schemas published for re-use by main document schemas.

[v0.212.1] - 2025-03-11

Changed

• bill: reverting back to maintaining precision in line totals for precise rounding for consistency with old data. Use currency rounding for compatibility with EN16931 specs.
• bill: line sum rounded to currency precision in currency rounding.

[v0.212.0] - 2025-03-10

Significant refinements to rounding and clarifying the naming for more clarity and widespread usage.

Added

• it-ticket-v1: implemented addon for AdE e-receipt format
• bill: line discount and charge base property, to use instead of the line sum in order to comply with EN16931.
• bill: line Charge support for Quantity and Rate special cases for charges like tariffs that result in a fixed amount base on a rate, like, 1 cent for every 100g of sugar.

Changed

• bill: line totals will be rounded to currency precision for presentation only
• bill: document Discount and Charge base and amounts always rounded to currency's precision
• bill: line Discount and Charge base and amounts always rounded to currency's precision
• tax: renamed rounding rules sum-then-round to precise, and round-then-sum to currency, to more accurately reflect their objectives.
• bill: currency rounding rule implies that line totals will be calculated with the currency's precisions, bringing closer alliance with EN16931 requirements.

[v0.211.0] - 2025-02-28

Another significant release that adds more documents related to the order-to-payment billing flows, and renames the "Receipt" document to simply "Payment". There are now 4 primary billing documents:

• Order
• Delivery
• Invoice
• Payment (renamed from Receipt)

Each document class has a subset of types to cover multiple situations. Its been tough, but we've tried to keep naming as simple and down to earth as possible so that every combination of document class and type should be easy to understand.

NOTE: the new billing document types are still considered experimental and subject to significant changes. Please use with caution.

Added

• bill: Delivery document now supported.
• bill: Order document now supported.
• bill: Payment - request type now supported.
• bill: Line now includes a breakdown array of sub-lines that will be used to calculate the item's price, including individual discounts and charges. This effectively implements grouping, while maintaining compatibility with all other formats that do not support breakdowns.
• bill: Line new substituted array of sub-lines for informational purposes when the originally requested line could not be fulfilled, especially relevant for orders.
• bill: Tax includes rounding field to be able to override the tax regimes default rounding mechanism.
• bill: CorrectionOptions now includes copy_tax flag, and will automatically copy tax details from a previous document.
• org: DocumentRef includes tax property with the Tax Totals of a previous document.

Changed

• bill: renaming Payment to PaymentDetails, and Delivery to DeliveryDetails, to make room for new document types.
• bill: renaming Receipt to Payment, and associated payment types to simply advice and receipt.
• org: Item price is now a pointer and optional, so that items without prices can be used in bill.Order and bill.Delivery documents. bill.Invoice continues to validate for the presence of an item's price, as expected.
• bill: PaymentLine tax property moved to the document.

Fixed

• pay: Terms, replaced NA option with explicit undefined key, to avoid defining empty constants in JSON.

[v0.210.0] - 2025-02-19

Added

• pt-saft-v1: support for payments and receipts

Changed

• pt-saft-v1: changed default unit to one
• bill: Line now incudes three new fields intended for greater EN16931 compatibility: identifier, period, order, and cost.
• org: Attachment new structure for dealing with attachments.
• bill: Attachments added to invoices.
• eu-en16931-v2017: addon now includes additional validation for attachment codes.

Fixed

• eu-en16931-v2017: removing validation of advanced payment means extension.
• pay: Card fields now optional.
• bill.Receipt: fixed panic calculating receipts with no lines
• bill.Receipt: require code only to sign
• bill.Receipt: calculate line indexes

[v0.209.0] - 2025-02-04

This significant release adds support for the new bill.Receipt schema, to be used to represent payments (sent from suppliers) and remittance advice (sent from customers). This is still in testing phases, so may still require significant changes.

Added

• bill: new Receipt model, including ReceiptLine.
• l10n: support for unions, including filtering members by date.
• l10n: european union including members.
• num: Negate method in amounts and percentages.
• fr-facturx-v1: addon placeholder dependent on eu-en16931-v2017
• de-zugferd-v2: addon placeholder dependent on eu-en16931-v2017
• pt, pt-saft-v1: new extensions, normalizations and validations.
• here: package will now convert unescaped ~ to backticks in documents.
• cbc: Source type, for defining sources of data.
• org: Unit one for generic use-cases.

Changed

• tax: (internal) tax total calculation moved to Total model from calculator.
• num: Invert now has deprecated warning.
• tax: CalculatorRoundingRule renamed to just RoundingRule
• eu-en16931-v2017: validate presence of item unit (BR-23).
• eu-en16931-v2017: improving validation of tax combos.
• eu-en16931-v2017: normalization with reasonable defaults for minimal invoices.

[v0.208.0] - 2025-01-07

Added

• gr-mydata: added gr-mydata-other-tax extension to set the category of other taxes in charges.
• untdid: 4451 - untdid-text-subject (Text Subject Qualifier) catalogue.

Changed

• org: Moved cbc.Note to org.Note in order to include extensions.
• tax: using ScenarioNote instead of cbc.Note to avoid cyclic dependency issues.

[v0.207.0] - 2024-12-12

Added

• es-verifactu-v1: added initial Spain VeriFactu addon.
• tax: Extensions Get convenience method that helps when using extensions using sub-keys.
• tax: ExtensionsExclude validator for checking that extensions do not include certain keys.
• tax: ExtValue.In for comparing extension values.
• bill: Tax.MergeExtensions convenience method for adding extensions to tax objects and avoid nil panics.
• cbc: Key.Pop method for splitting keys with sub-keys, e.g. cbc.Key("a+b").Pop() == cbc.Key("a").
• in: added Indian regime
• cef: catalogue for CEF VATEX reason codes.
• untdid: 1153 - untdid-reference (Reference Code Qualifier) and 7143 - untdid-item-type (Item Type Identification) extensions.

Changed

• tax: renamed ExtensionsRequires to ExtensionsRequire, to bring in line with ExtensionsExclude.
• cbc: refactored KeyDefinition and ValueDefinition into a single Definition object that supports key and code.
• tax: removed ExtValue and replaced with cbc.Code which is now much more flexible.
• tax: Catalogue definitions now loaded from JSON source as opposed to Go code. This improves memory efficiency, especially when the source data is large.

Fixed

• bill: corrected issues around correction definitions and merging types.
• bill: removed Outlays from totals.

[v0.206.1] - 2024-11-28

Fixed

• org: Party validation now working with regimes when defined.

[v0.206.0] - 2024-11-26

Added

• ae: added UAE regime
• br-nfse-v1: new extensions, validations & identities for the typical service note and supplier.

Changed

• es-tbai-v1: always add es-tbai-product extension to items, indicating default value.

Fixed

• es-tbai-v1: issue with preceding validation.

[v0.205.1] - 2024-11-19

Added

• org: Address includes LineOne(), LineTwo(), CompleteNumber() methods to help with conversion to other formats with some regional formatting.

Changes

• bill: Invoice can now have empty lines if discounts or charges present.

Fixes

• ch: Deleted Supplier validation (not needed for under 2300 CHF/year)
• bill: Invoice GetExtensions method now works correctly if missing totals Issue #424.

[v0.205.0] - 2024-11-12

Added

• org: Address now includes a state code, for countries that require them.
• es-tbai-v1: normalize address information to automatically add new es-tbai-region extension to invoices.
• org: Inbox now supports email field, with auto-normalization of URLs and emails in the code field.
• currency: Exchange rate "source" field.

Changes

• Moved regime examples into single /examples folder.
• org: Address, code for the post code is now typed as a cbc.Code, like the new state field.

Fixes

• cal: Fixing json schema issue with date times.

[v0.204.1] - 2024-11-04

Added

• bill: normalize line discounts and charges to remove empty rows.

Fixed

• tax: identity code handling will skip default validation for specific countries that use special characters.

[v0.204.0] - 2024-10-31

Added

• br-nfse-v1: added initial Brazil NFS-e addon

Changed

• mx: deprecated the mx-cfdi-post-code extension in favor of the customer address post code.
• New "tax catalogues" used for defining extensions for specific standards.
• tax: New "tax catalogues" used for defining extensions for specific standards.
• iso: catalogue created with iso-schema-id extensions.
• untdid: catalogue created with extensions: untdid-document-type, untdid-payment-means, untdid-tax-category, untdid-allowance, and untdid-charge.
• eu-en16931-v2017: addon for underlying support of the EN16931 semantic specifications.
• de-xrechnung-v3: addon with extra normalization for XRechnung specification in Germany.
• pay: Added sepa payment means key extension in main definition to be used with Credit Transfers and Direct Debit.
• org: Identity and Inbox support for extensions.
• tax: tags for export and eea (european economic area) for use with rates.
• bill: support for extensions in Discount, Charge, LineDiscount, and LineCharge.
• bill: specifically defined keys for Discounts and Charges.

Changed

• tax: rate keys can now be extended, so exempt+reverse-charge will be accepted and may be used by addons to included additional codes.
• tax: Addons can now depend on other addons, whose keys will be automatically added during normalization.
• cbc: Code now allows : separator.

Removed

• pay: UNTDID 4461 mappings from payment means table, now provided by catalogues
• bill: Outlay has been removed in favour of Charges, we've also not seen any evidence this field has been used.
• bill: ref field from discounts and charges in favour of code.
• tax: Regime ChargeKeys removed. Keys now provided in bill package.
• it: Charge keys no longer defined, no migration required, already supported.

Fixed

• mx: Tax ID validation now correctly supports & and Ñ symbols in codes.

[v0.203.0] - 2024-20-21

Added

• br: added basic Brazil regime
• uuid: SQL library compatibility for type conversion.
• it-sdi-v1: added it-sdi-vat-liability extension for EsigibilitaIVA.

Fixed

• bill.Invoice: remove empty taxes instances.
• tax.Identity: support Calculate method to normalize IDs.
• tax.Regime: properly set regime when alternative codes is given.

[v0.202.0] - 2024-10-14

Changed

• org.DocumentRef: renamed line to lines that accepts an array of integers making it possible to define a selection of reference lines in another document as opposed to just one.

Added

• cbc.Code: new Join and JoinWith methods to help concatenate codes.
• it-sdi-v1: added CIG and CUP identity type codes.
• de: added validation and normalization for tax identities (not VAT).

Fixed

• mx: fixed panic when normalizing an invoice with tax but no ext inside.

[v0.201.0] - 2024-10-07

Fixed

• es-tbai-v1: added validation for presense of series and general notes in Invoices.
• es: moving invoice customer validation to the facturae and tbai addons.
• it-sdi-v1: fixing validation issue for payment terms with no due dates.

Changed

• pt: reduced rate category for PT-MA was updated to reflect latest value of 4%
• co-dian-v2: moved from co tax regime into own addon.

[v0.200.1] - 2024-09-30

Fixed

• pt: moving invoice tags from saft addon to regime, ensure defaults present.

[v0.200.0] - 2024-09-26

Another significant epic release. Introducing "add-ons" which move the normalization and validation rules from Tax Regimes to specific packages that need to be enabled inside a document to be used.

Tax Regimes are now also defined using the $regime keyword at the top of the document under the $schema and alongside $addons and $tags. This is a significant move with the aim of making the core GOBL project as flexible as possible, while allowing greater levels of validation and customization to be added as needed.

Another very significant internal change is around normalization. There is now a much clearer difference internally between Calculate and Normalize methods. Calculate methods are used when there is some type of math operation to perform, and normalize will simply clean the data as much as possible. The three key steps in order are: normalize, calculate, and validate.

Finally, the draft flag has been removed from the header, and much more emphasis has been placed on the signatures for validation. For example, the invoice's "code" property will only be required in order to sign the envelope.

(We've made a big jump in minor version numbers to clarify the extent of the changes.)

Changed

• head.Header: Removed the draft flag. Instead envelopes must now be signed in order to activate additional validation rules such as requiring the invoice code, and allow "stamps" in the header.
• Renamed Calculate methods to Normalize and removed errors, to clearly differentiate between the two processes.
• bill: Moved tax tags to the invoice level $tags property.
• tax: Renamed Regime to RegimeDef.
• tax: Renamed Category to CategoryDef.
• tax: Renamed Rate to RateDef.
• tax: Renamed RateValue to RateValueDef.
• mx: local normalization, validation, and extensions moved to the addons/mx/cfdi package to use with the mx-cfdi-v4 key.
• es: moved FacturaE and TicketBAI extensions to the addons/es/facturae and addons/es/tbai packages respecitvely.
• pt: moved SAF-T specific extensions to addons/pt/saft.
• it: moved SDI and FatturaPA extensions to addons/it/sdi with key it-sdi-v1.
• gr: moved MyDATA to addons/gr/mydata, key gr-mydata-v1.
• bill.Preceding: replaced with org.DocumentRef.
• bill.Invoice: Ordering now using arrays of org.DocumentRef.
• bill.Invoice: series and code now use cbc.Code and normalization instead of the independent invoice code.
• cbc: Code now allows spaces, dashes, and lower-case letters. Normalization will remove duplicate symbols.

Added

• tax: Regime type now used to add $regime attribute to documents.
• tax: Addons type which uses the $addons attribute to control which addons apply to the document.
• tax: Tags type which adds the $tags attribute.
• tax: Scenario now has Filter property to set a code function.
• tax: AddonDef provides support for defining addon extension packs.
• gr: gr-mydata-invoice-type extension with related tags and scenarios.
• org: DocumentRef consolidates references to previous documents in a single place.
• bill: invoice type option other for usage when regular scenarios do not apply.

[v0.115.1] - 2024-09-10

Fixes

• tax: totals calculator was ignoring tax combos with rate and percent, when they should be classed as exempt.

[v0.115.0] - 2024-09-10

This one is big...

Significant set of changes around Scenario handling. Scenarios defined by tax regimes can now set tax extensions at the document level automatically. The objective here is to move away from external projects using scenario summaries directly, and instead use the absolute values set in the document.

For example, the document format and type in Italy are now set inside the extensions and can be overriden if needed manually. This will be especially important when receiving and converting invoices into GOBL from external formats; its much easier to set specific values than trying to determine the appropriate tags.

Also included is support for defining the country in tax combos, making it possible for taxes from a customers country to applied directly if needed. Typical use case would be for selling digital goods into or between EU states for B2C customers.

Invoices in GOBL can now also finally produced for any country in the world, even if not explicitly defined inside the tax regimes.

Changed

• bill.Invoice: customer can now be empty by default, the simplified simplified tag will have no effect on the document unless used by regime scenarios.
• bill.Invoice: using the customer-rates tag will now automatically copy the customer's country code, if available, to the individual tax combo lines.
• tax: moved NormalizeIdentity method from the regimes common package so that it can be applied to all tax IDs, regardless of if they have a regime defined or not.
• pt: VAT rate key is now optional if pt-saft-tax-rate is provided.
• gr: simplified validation to use tax categories.
• it: always add it-sdi-fiscal-regime to Invoice suppliers.
• it: renamed extension it-sdi-retained-tax to it-sdi-retained, now with validation on retained taxes.
• it: renamed extension it-sdi-natura to it-sdi-exempt.
• bill.Invoice: deprecated the ScenarioSummary method, as tax regimes themselves should be using extensions to apply all the correct data to a document up front.
• mx: scenarios will now copy the document and relation types to the tax extensions.
• cbc: consolidated "keys" and "codes" lists from key definitions into a single values array.
• gr: switched to use the new round-then-sum calculation method
• tax.Combo: rates when defined will always update the combo.
• bill.Invoice: tax tags will always cause scenarios to update the document.
• es: support for facturae tag which will correct set local extensions instead of using scenario summary codes.

Added

• tax: Combo now supports a country field.
• tax.Category: added Validation method support for custom validation of a tax combo for a specific tax category.
• tax.Scenario: added "extensions" to be able to automatically update document level extensions based on the scenario detected.
• it: added ExtKeySDIDocumentType as an extension that will be automatically included according to the scenario.
• it: now adding ExtKeySDIFormat value to document instead of just referencing from scenarios.
• cbc.Note: now provides SameAs method that will compare key attributes, but not the text payload. This is now used in Schema Summaries.
• bill.Line: added RequireLineTaxCategory validation helper method.
• cbc: added new ValueDefinition.
• gr: added "Income Classification" extensions.
• tax.TotalCalculator: now supports round-then-sum as an alternative to the default sum-then-round calculation method to meet the requirements of regimes like Greece.

Removed

• tax.Category: removed RateRequired flag, regimes should instead should help users determine valid extensions (eg. PT and GR).
• cbc: removed CodeDefinition.

Fixed

• tax.Scenario: potential issue around matching notes.
• tax.Set: improved validation embedded error handling.

[v0.114.0] - 2024-08-26

Changed

• org.Name: either given or surname are required, as opposed to both at the same time.

[v0.113.0] - 2024-08-01

Added

• head: validation rule to check for the presence of stamps
• GR: support for credit notes

[v0.112.0] - 2024-07-29

Significant set of small changes related to renaming of the l10n.CountryCode type. The main reason for this is an attempt to reduce confusion between regular ISO country selection, and the specific country codes used for tax purposes. Normally they coincide, but exception cases like for Greece, whose ISO code is GR but use EL for tax purposes, or XI for companies in Northern Ireland, mean that there needs to be a clear selection.

Changed

• CO: improved regime's documentation
• l10n: split "CountryCode" into "ISOCountryCode" and "TaxCountryCode", for the two explicit use-cases.
• l10n: renamed CountryDefinitions variable to Countries() method.

Added

• Code coverage report (still a lot to improve there!)
• GR: support for simplified invoices
• l10n: ISO and Tax lists of country definitions available, e.g. l10n.Countries().ISO()
• tax: support for alternative country codes
• tax: Scenarios now handle extension key and value for filtering.
• PT: exemption text handling moved to scenarios.

Upgraded

• invopop/validation - upgrade to latest version with nil pointer fix.

Fixed

• GR: fixed certain tax combos not getting calculated by the regime

[v0.111.1] - 2024-07-25

Added

• org.Address: recommended fields added

Changed

• org.Address: locality no longer required.

[v0.111.0] - 2024-07-24

Added

• Including recommended array in more JSON Schema objects.
• bill.Invoice: validation and changes around acceptance of simplified invoices with customer name. A customer without a tax ID now implies that a name is also not required.
• uuid: Compact Base64 encoding and decoding of UUIDs for compact URLs.
• head: New Link model for associating Envelopes with static URLs.
• head.Header: Link array in addition to stamps.
• PT: support for debit notes
• PT: validations for debit and credit notes

Changed

• CO: renamed credit and debit extension names to fit in UIs.
• org.Party: name is now optional, but recommended.

Fixed

• org.People: name is now correctly validated.

[v0.110.2] - 2024-07-23

Added

• org.Person: now has label field.

Changed

• org: Refining availability of label field.

[v0.110.0] - 2024-07-23

Multiple version upgrade after merging the gobl.cli project directly here instead.

Added

• CLI: move the command line interface and wasm binary support directly into GOBL.

[v0.83.0] - 2024-07-23

Added

• CO: support debit notes with additional validations for required reason extensions.

Changed

• CO: renaming co-dian-correction code to co-dian-credit-code while also adding co-dian-debit-code to extensions.
• CO: support debit notes
• CO: updated validation for simplified invoices
• GR: renamed greece country code to EL to reflect local naming in tax code, package still named gr for ease of use.
• l10n: extension countries like EL, XI, EU for special tax cases
• l10n: country definition extension flag to be able to filter ISO codes

Fixed

• IT: Company fiscal code can be the same as the VAT code.

[v0.82.0] - 2024-07-19

Added

• bill.Invoice: experimental ConvertInto method to convert the invoice's amounts from one currency into another.
• DE: support for "de-tax-number" identity which can be used instead of regular tax ID code inside Germany.
• DE: "simplified" tax tag removes requirement for supplier tax identification.

[v0.81.0] - 2024-07-17

Added

• tax.Regime: added new "Identity Keys" definition.
• IT: it-sdi-format extension added with the two main document formats in Italy: FPA12 and FPR12 (default for B2B/C if none assigned).

Changed

• tax.Identity: deprecated the type field, and directly removed the uuid and meta fields which no longer make sense here.
• tax.Regime: standardised naming around key definitions to always include _keys as suffix.
• IT: moved fiscal code (codice fiscale) from the org.Party Tax ID to the Identities array with the specific key it-fiscal-code. This implies that invoices can now be issued with both a VAT code (partita IVA) and a fiscal code (codice fiscale).
• IT: data will be normalized automatically to move the fiscal code from the tax ID to the identities array.
• IT: removed explicit support for Tax ID type field.
• ES: moved Tax ID type usage to the identities array.
• CO: moved Tax ID type definitions to identities array.

[v0.80.1] - 2024-07-11

Added

• GR: Invoice and address validations
• GR: Payment means key definitions

Changed

• GB: removed requirement for suppliers to have a tax ID code (country is still required!)

[v0.80.0] - 2024-06-27

Added

• num.Amount - RescaleDown method, that helps reduce accuracy from a number if higher.
• num.Amount - RescaleRange method, ensures that the exponent is within a specific range.
• Greece tax regime
• tax.Combo - regime specific calculations now supported.

[v0.79.3] - 2024-06-18

Added

• org.Registration: added other field.

Fixed

• Field descriptions of org.Website

[v0.79.2] - 2024-06-18

Added

• PT: at-app-id stamp for the application ID used to register a document.

[v0.79.1] - 2024-06-18

Added

• num.AmountFromFloat64 method helps avoid rounding issues when using floats.
• PT: at-hash stamp to store the AT's hash of an invoice

Changed

• MX: Fuel account balance totals calculated maintaining item price precision.

[v0.79.0] - 2024-06-05

Added

• ISO 3166-1 alpha-3 codes (and a function to access them) added to the country definitions (l10n.CountryDef)
• MX: mx.TaxIdentityCodeGeneric constant added with the generic RFC for final consumers

Changed

• MX: customer extensions no longer required for foreign customers

[v0.78.1] - 2024-05-30

Fixed

• CH: fixing tax ID checksum validation that ends in 0.

[v0.78.0] - 2024-05-23

Added

• Default values added to correction options schema based on values from previous invoice.

Changed

• In pay.Online, renamed name property to label, and addr to URL. Also added key property. Auto-migration included.

Fixed

• bill.Invoice: fixed issue with invalid currency codes that don't have a definition, will always resort to Tax Regime's currency.

[v0.77.0] - 2024-05-16

Fixing important bugs with some tax regimes and tax identity code validation, along with a new 'series' property for correction options.

Added

• series property added to bill Correction Options to allow a series for a credit note to be added.
• label property added to org.Party.

Changed

• Invoice Discounts and Charges will no longer update the base property according to the document's sum.
• Exempt rate in tax.Combo no longer required when percent is empty.
• When correcting an invoice, if no new series is provided, the previous document's series will be maintained.

Fixed

• Precision handling of calculated invoice discounts and charges.
• Multiple tax regime were not validating the presence of supplier identity code.

[v0.76.0] - 2024-05-13

Finally, invoice multi-currency support! It's been a very long time coming, but we've finalized the details on how to handle currency conversion in invoices and potentially other documents.

Added

• Invoice Line Item alternative pricing added to be able to define custom prices in different currencies: line.AltPrices
• Automatic conversion of invoice line item prices into invoice currency based on exchange rates defined in invoice if no alternative prices provided.
• If an invoice has a currency that is different from that of the tax regime, a validation rule ensures that an exchange rate is defined.
• currency.Amount - new model that combines a currency with an amount.
• BE: added Belgium regime.

Changed

• BREAKING: refactor of currency.ExchangeRate to clearly define from and to currencies (this was never supported, so we're not expecting anything to actually break).
• Removed all regime specific currency validation, this is now performed by the invoice and depends on the available exchange rates.
• MX: invoice line totals validated to be zero or more, instead of positive.

Fixed

• Removing code requirement from Tax ID validation in all regimes so that when issuing a document to another country, the customers tax ID code will be validated if present, but will not be required. Any local rules for the issuing country for foreign IDs will continue to be applied.

[v0.75.1] - 2024-05-07

Change

• MX: allow line taxes to be empty.

[v0.75.0] - 2024-05-06

Added

• Bill Invoice Tax objects now support tax extensions.
• MX Stamps for signatures from CFDI and SAT.
• MX: extension for Place of Issue code: mx-cfdi-issue-place that replaces previous post code option in the supplier. Automatic normalization added.
• head package now has GetStamp method to find a stamp by its provider from an array.
• num.Percentage has Base() method to access base amount.
• MX: FuelAccountBalance complement now supports percent as an alternative to rate.
• ES: added extra TicketBAI exemption reasons
• Envelope Replicate() and supporting methods to be able to clone/replicate an envelope or document without any potentially conflicting data.

Changed

• reverse-charge tag will no longer have impact on tax calculations, each tax combo per line should define if taxes are exempt or not.
• Renaming mx.StampProviderSATUUID constant to just mx.StampSATUUID.
• MX: FuelAccountBalance complement renamed tax code to cat (Category) with explicit usage of regular tax codes to be more aligned with other usage of tax categories.

Fixed

• UUID IsNotZero will not raise error for empty UUIDs.

[v0.74.1] - 2024-05-23

UUID Unmarshal fix.

Fixed

• UUID: parsing empty strings from JSON no longer causes error.

[v0.74.0] - 2024-05-23

Refining UUID library and moving to using version 7 as the default in GOBL.

Added

• Additional UUID validation rules: Valid, IsV6, Isv7, HasTimestamp, and Timeless.

Changed

• Using Version 7 UUIDs as default in GOBL. This version enables ordering by UUID and uses random extra data instead of a node ID.

Fixed

• Parsing empty UUIDs now returns an empty UUID instead of an error.

[v0.73.0] - 2024-04-22

Refactoring UUID support.

IMPORTANT: When running Calculate(), a uuid will now be assigned automatically to the document embedded in an Envelope if not already set. This is important to ensure that links between documents can always be maintained, no matter the source.

Added

• Schema Object: Calculate() will now inject UUIDs.
• Schema Object: UUID() method will provide the UUID of the underlying document.
• schema.Identifiable interface to be able to read and set UUIDs on documents.
• uuid.Identify that makes it easier to embed UUIDs into documents with helper methods.

Changed

• UUID: refactored to use underlying string type instead of external package. This makes it easier to manage empty values, and avoids usage of pointers.
• Removed all pointers to UUIDs and many cases replaced with uuid.Identify embedded structure.

Fixed

• none

[v0.72.0] - 2024-04-18

Refactoring region handling for Portugal VAT and now supporting - in cbc.Code.

Added

• Regimes: Extensions can now be used to match tax rates.
• Tax: Extensions helper methods: Merge and Contains.

Changed

• cbc.Code: Now supports - symbol alongside . as a separator. Mixed feelings on this as we wanted to avoid normalization complications, but it became clear with the PT changes that a bit more flexibility here is useful. (Side note: the original intent of cbc.Code was to avoid dashes in tax IDs, but these are now normalized automatically.)
• PT: moving from tax tags azores and madeira to pt-region extension provided in taxes combo for each line.
• PT: auto-migrate invoice supplier tax ID zone to appropriate line tax combo extension.

Fixed

• none

[v0.71.0] - 2024-04-08

New number formatting support! Expect some possible breaking SDK changes with the num packages. No significant schema changes.

Added

• This CHANGELOG.md file (finally!)
• Swiss (CH) tax regime.
• Austrian (AT) tax regime.
• num package now provides advanced number formatting.
• currency provides "definitions" loaded from JSON with support for formatting.
• Polish (PL) correction and preceding validation.
• Polish (PL) header stamps for QR code.

Changed

• num package refactored so that num.Percentage is independent from num.Amount.

Fixed

• Minor fixes around tax regime definitions.
• invopop/yaml upgraded.

[v0.70.1] - 2024-03-25

• Last version before CHANGELOG.md.