gobl 0.20.0 → 0.21.0

data/data/regimes/mx.json

@@ -61,6 +61,18 @@
     }
   ],
   "extensions": [
+    {
+      "key": "mx-cfdi-issue-place",
+      "name": {
+        "en": "Place of Issue",
+        "es": "Lugar de Expedición"
+      },
+      "desc": {
+        "en": "Post code of where the invoice was issued. In CFDI, this translates to the 'LugarExpedicion'.",
+        "es": "Código postal de donde se emitió la factura. En CFDI se traduce a 'LugarExpedicion'."
+      },
+      "pattern": "^[0-9]{5}$"
+    },
     {
       "key": "mx-cfdi-post-code",
       "name": {
@@ -68,8 +80,8 @@
         "es": "Código Postal"
       },
       "desc": {
-        "en": "Post code of where the invoice was issued.\nIn CFDI, this translates to the 'LugarExpedicion' in the case of the supplier\nand 'DomicilioFiscalReceptor' for customers.\nExample value: '01000'.",
-        "es": "Código postal de donde se emitió la factura.\nEn CFDI se traduce a 'LugarExpedicion' en el caso del emisor, y\n'DomicilioFiscalReceptor' para el receptor.\nValor de ejemplor: '01000'."
+        "en": "Post code of a supplier or customer to use instead of an address. Example: \"01000\".",
+        "es": "Código postal de un emisor o receptor para usar en lugar de una dirección. Ejemplo: \"01000\"."
       },
       "pattern": "^[0-9]{5}$"
     },
@@ -393,7 +405,7 @@
       ]
     }
   ],
-  "payment_means": [
+  "payment_means_keys": [
     {
       "key": "cash",
       "name": {

data/data/regimes/nl.json

@@ -77,6 +77,14 @@
       ]
     }
   ],
+  "corrections": [
+    {
+      "schema": "bill/invoice",
+      "types": [
+        "credit-note"
+      ]
+    }
+  ],
   "categories": [
     {
       "code": "VAT",

data/data/regimes/pl.json

@@ -116,9 +116,51 @@
           }
         }
       ]
+    },
+    {
+      "key": "pl-ksef-effective-date",
+      "name": {
+        "en": "Effective date code.",
+        "pl": "Kod daty wejścia w życie."
+      },
+      "codes": [
+        {
+          "code": "1",
+          "name": {
+            "en": "Original",
+            "pl": "Pierwotna"
+          },
+          "desc": {
+            "en": "Effective according to date of the original invoice.",
+            "pl": "Faktura skutkująca w dacie ujęcia faktury pierwotnej."
+          }
+        },
+        {
+          "code": "2",
+          "name": {
+            "en": "Correction",
+            "pl": "Korygująca"
+          },
+          "desc": {
+            "en": "Effective according to date of correction.",
+            "pl": "Faktura skutkująca w dacie ujęcia faktury korygującej."
+          }
+        },
+        {
+          "code": "3",
+          "name": {
+            "en": "Other",
+            "pl": "Inna"
+          },
+          "desc": {
+            "en": "Correction has legal consequences in another date or the dates are different for different position on the invoice",
+            "pl": "Faktura skutkująca w innej dacie. W tym gdy dla różnych pozycji faktury korygującej data jest różna."
+          }
+        }
+      ]
     }
   ],
-  "payment_means": [
+  "payment_means_keys": [
     {
       "key": "cash",
       "name": {
@@ -253,11 +295,11 @@
         },
         {
           "type": [
-            "corrective"
+            "credit-note"
           ],
           "name": {
-            "en": "Corrective Invoice",
-            "pl": "Faktura Korygująca"
+            "en": "Credit note",
+            "pl": "Faktura korygująca"
           },
           "codes": {
             "favat-rodzaj-faktury": "KOR"
@@ -265,13 +307,13 @@
         },
         {
           "type": [
-            "corrective"
+            "credit-note"
           ],
           "tags": [
             "partial"
           ],
           "name": {
-            "en": "Corrective Prepayment Invoice",
+            "en": "Prepayment credit note",
             "pl": "Faktura korygująca fakturę zaliczkową"
           },
           "codes": {
@@ -280,13 +322,13 @@
         },
         {
           "type": [
-            "corrective"
+            "credit-note"
           ],
           "tags": [
             "settlement"
           ],
           "name": {
-            "en": "Corrective Settlement Invoice",
+            "en": "Settlement credit note",
             "pl": "Faktura korygująca fakturę rozliczeniową"
           },
           "codes": {
@@ -296,6 +338,21 @@
       ]
     }
   ],
+  "corrections": [
+    {
+      "schema": "bill/invoice",
+      "types": [
+        "credit-note"
+      ],
+      "extensions": [
+        "pl-ksef-effective-date"
+      ],
+      "reason_required": true,
+      "stamps": [
+        "ksef-id"
+      ]
+    }
+  ],
   "categories": [
     {
       "code": "VAT",

data/data/regimes/pt.json

@@ -65,31 +65,39 @@
         "en": "Invoice-receipt",
         "pt": "Fatura-recibo"
       }
-    },
+    }
+  ],
+  "extensions": [
     {
-      "key": "azores",
+      "key": "pt-region",
       "name": {
-        "en": "Azores",
-        "pt": "Açores"
+        "en": "Region Code",
+        "pt": "Código da Região"
       },
-      "desc": {
-        "en": "Tag for use when the invoice is issued in the Azores region with special local rates.",
-        "pt": "Tag para uso quando a fatura é emitida na região dos Açores com taxas locais especiais."
-      }
+      "codes": [
+        {
+          "code": "PT",
+          "name": {
+            "en": "Mainland Portugal",
+            "pt": "Portugal Continental"
+          }
+        },
+        {
+          "code": "PT-AC",
+          "name": {
+            "en": "Azores",
+            "pt": "Açores"
+          }
+        },
+        {
+          "code": "PT-MA",
+          "name": {
+            "en": "Madeira",
+            "pt": "Madeira"
+          }
+        }
+      ]
     },
-    {
-      "key": "madeira",
-      "name": {
-        "en": "Madeira",
-        "pt": "Madeira"
-      },
-      "desc": {
-        "en": "Tag for use when the invoice is issued in the Madeira region with special local rates.",
-        "pt": "Tag para uso quando a fatura é emitida na região da Madeira com taxas locais especiais."
-      }
-    }
-  ],
-  "extensions": [
     {
       "key": "pt-exemption-code",
       "name": {
@@ -381,16 +389,16 @@
           },
           "values": [
             {
-              "tags": [
-                "azores"
-              ],
+              "ext": {
+                "pt-region": "PT-AC"
+              },
               "since": "2011-01-01",
               "percent": "16.0%"
             },
             {
-              "tags": [
-                "madeira"
-              ],
+              "ext": {
+                "pt-region": "PT-MA"
+              },
               "since": "2011-01-01",
               "percent": "22.0%"
             },
@@ -411,16 +419,16 @@
           },
           "values": [
             {
-              "tags": [
-                "azores"
-              ],
+              "ext": {
+                "pt-region": "PT-AC"
+              },
               "since": "2011-01-01",
               "percent": "9.0%"
             },
             {
-              "tags": [
-                "madeira"
-              ],
+              "ext": {
+                "pt-region": "PT-MA"
+              },
               "since": "2011-01-01",
               "percent": "12.0%"
             },
@@ -441,16 +449,16 @@
           },
           "values": [
             {
-              "tags": [
-                "azores"
-              ],
+              "ext": {
+                "pt-region": "PT-AC"
+              },
               "since": "2011-01-01",
               "percent": "4.0%"
             },
             {
-              "tags": [
-                "madeira"
-              ],
+              "ext": {
+                "pt-region": "PT-MA"
+              },
               "since": "2011-01-01",
               "percent": "5.0%"
             },
@@ -477,6 +485,9 @@
             "at-tax-code": "ISE"
           }
         }
+      ],
+      "extensions": [
+        "pt-region"
       ]
     }
   ]

data/data/regimes/us.json

@@ -59,6 +59,15 @@
       }
     }
   ],
+  "corrections": [
+    {
+      "schema": "bill/invoice",
+      "types": [
+        "credit-note",
+        "debit-note"
+      ]
+    }
+  ],
   "categories": [
     {
       "code": "ST",

data/lib/generated/gobl/bill/charge.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Charge'
 
       # @!attribute [r] uuid
-      # Unique identifying for the discount entry
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] key
       # Key for grouping or identifying charges for tax purposes.
@@ -24,7 +23,7 @@ module GOBL
       property :key, GOBL::CBC::Key
 
       # @!attribute [r] i
-      # Line number inside the list of discounts (calculated).
+      # Line number inside the list of charges (calculated).
       # @return [Integer]
       property :i, Integer
 
@@ -34,12 +33,12 @@ module GOBL
       property :ref, String
 
       # @!attribute [r] base
-      # Base represents the value used as a base for percent calculations. If not already provided, we'll take the invoices sum before discounts.
+      # Base represents the value used as a base for percent calculations instead of the invoice's sum of lines.
       # @return [GOBL::Num::Amount]
       property :base, GOBL::Num::Amount
 
       # @!attribute [r] percent
-      # Percentage to apply to the invoice's Sum
+      # Percentage to apply to the Base or Invoice Sum
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 

data/lib/generated/gobl/bill/correction_options.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -24,6 +23,11 @@ module GOBL
       # @return [GOBL::Cal::Date]
       property :issue_date, GOBL::Cal::Date
 
+      # @!attribute [r] series
+      # Series to assign to the new corrective invoice.
+      # @return [String]
+      property :series, String
+
       # @!attribute [r] stamps
       # Stamps of the previous document to include in the preceding data.
       # @return [Array<GOBL::Head::Stamp>]

data/lib/generated/gobl/bill/delivery.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/discount.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Discount'
 
       # @!attribute [r] uuid
-      # Unique identifying for the discount entry
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] i
       # Line number inside the list of discounts (calculated)
@@ -29,12 +28,12 @@ module GOBL
       property :ref, String
 
       # @!attribute [r] base
-      # Base represents the value used as a base for percent calculations. If not already provided, we'll take the invoices sum.
+      # Base represents the value used as a base for percent calculations instead of the invoice's sum of lines.
       # @return [GOBL::Num::Amount]
       property :base, GOBL::Num::Amount
 
       # @!attribute [r] percent
-      # Percentage to apply to the invoice's Sum.
+      # Percentage to apply to the base or invoice's sum.
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 

data/lib/generated/gobl/bill/document_reference.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -15,8 +14,8 @@ module GOBL
 
       # @!attribute [r] uuid
       # Unique ID copied from the source document.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] series
       # Series the reference document belongs to.

data/lib/generated/gobl/bill/invoice.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,16 +13,16 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice'
 
       # @!attribute [r] uuid
-      # Unique document ID. Not required, but always recommended in addition to the Code.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # Enumeration of possible values for {#type} with their corresponding descriptions
       TYPE_ENUM = {
         'standard' => 'A regular commercial invoice document between a supplier and customer.',
         'proforma' => 'For a clients validation before sending a final invoice.',
         'corrective' => 'Corrected invoice that completely *replaces* the preceding document.',
-        'credit-note' => 'Reflects a refund either partial or complete of the preceding document. A 
+        'credit-note' => 'Reflects a refund either partial or complete of the preceding document. A
       credit note effectively *extends* the previous document.',
         'debit-note' => 'An additional set of charges to be added to the preceding document.'
       }.freeze

data/lib/generated/gobl/bill/line.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Line'
 
       # @!attribute [r] uuid
-      # Unique identifier for this line
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] i
       # Line number inside the parent (calculated)

data/lib/generated/gobl/bill/line_charge.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/line_discount.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/ordering.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/outlay.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Outlay'
 
       # @!attribute [r] uuid
-      # Unique identity for this outlay.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] i
       # Outlay number index inside the invoice for ordering (calculated).

data/lib/generated/gobl/bill/payment.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/preceding.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,16 +13,16 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Preceding'
 
       # @!attribute [r] uuid
-      # Preceding document's UUID if available can be useful for tracing.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Preceding document's UUID.
+      # @return [String]
+      property :uuid, String
 
       # Enumeration of possible values for {#type} with their corresponding descriptions
       TYPE_ENUM = {
         'standard' => 'A regular commercial invoice document between a supplier and customer.',
         'proforma' => 'For a clients validation before sending a final invoice.',
         'corrective' => 'Corrected invoice that completely *replaces* the preceding document.',
-        'credit-note' => 'Reflects a refund either partial or complete of the preceding document. A 
+        'credit-note' => 'Reflects a refund either partial or complete of the preceding document. A
       credit note effectively *extends* the previous document.',
         'debit-note' => 'An additional set of charges to be added to the preceding document.'
       }.freeze

data/lib/generated/gobl/bill/tax.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -23,6 +22,11 @@ module GOBL
       # @return [Array<GOBL::CBC::Key>]
       property :tags, [GOBL::CBC::Key]
 
+      # @!attribute [r] ext
+      # Additional extensions that are applied to the invoice as a whole as opposed to specific sections.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+
       # @!attribute [r] meta
       # Any additional data that may be required for processing, but should never be relied upon by recipients.
       # @return [GOBL::CBC::Meta]

data/lib/generated/gobl/bill/totals.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cal/date.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cal/date_time.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cal/period.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/code.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/code_definition.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL