gobl 0.24.1 → 0.24.3

data/data/currency/non-iso.json

@@ -0,0 +1,128 @@
+[
+  {
+    "priority": 100,
+    "iso_code": "BCH",
+    "name": "Bitcoin Cash",
+    "symbol": "₿",
+    "disambiguate_symbol": "₿CH",
+    "alternate_symbols": ["BCH"],
+    "subunit_name": "Satoshi",
+    "subunits": 8,
+    "template": "%n %u",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "BTC",
+    "name": "Bitcoin",
+    "symbol": "₿",
+    "alternate_symbols": [],
+    "subunit_name": "Satoshi",
+    "subunits": 8,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "JEP",
+    "name": "Jersey Pound",
+    "symbol": "£",
+    "disambiguate_symbol": "JEP",
+    "alternate_symbols": [],
+    "subunit_name": "Penny",
+    "subunits": 2,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "GGP",
+    "name": "Guernsey Pound",
+    "symbol": "£",
+    "disambiguate_symbol": "GGP",
+    "alternate_symbols": [],
+    "subunit_name": "Penny",
+    "subunits": 2,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "IMP",
+    "name": "Isle of Man Pound",
+    "symbol": "£",
+    "disambiguate_symbol": "IMP",
+    "alternate_symbols": ["M£"],
+    "subunit_name": "Penny",
+    "subunits": 2,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "XFU",
+    "name": "UIC Franc",
+    "symbol": "",
+    "disambiguate_symbol": "XFU",
+    "alternate_symbols": [],
+    "subunit_name": "",
+    "subunits": 2,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "GBX",
+    "name": "British Penny",
+    "symbol": "",
+    "disambiguate_symbol": "GBX",
+    "alternate_symbols": [],
+    "subunit_name": "",
+    "subunits": 1,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "CNH",
+    "name": "Chinese Renminbi Yuan Offshore",
+    "symbol": "¥",
+    "disambiguate_symbol": "CNH",
+    "alternate_symbols": ["CN¥", "元", "CN元"],
+    "subunit_name": "Fen",
+    "subunits": 2,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
+  {
+    "priority": 100,
+    "iso_code": "USDC",
+    "name": "USD Coin",
+    "symbol": "USDC",
+    "disambiguate_symbol": "USDC",
+    "alternate_symbols": [],
+    "subunit_name": "Cent",
+    "subunits": 2,
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  }
+]

data/data/schemas/bill/charge.json

@@ -0,0 +1,125 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/charge",
+  "$ref": "#/$defs/Charge",
+  "$defs": {
+    "Charge": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "i": {
+          "type": "integer",
+          "title": "Index",
+          "description": "Line number inside the list of charges (calculated).",
+          "calculated": true
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "anyOf": [
+            {
+              "const": "stamp-duty",
+              "title": "Stamp Duty"
+            },
+            {
+              "const": "outlay",
+              "title": "Outlay"
+            },
+            {
+              "const": "tax",
+              "title": "Tax"
+            },
+            {
+              "const": "customs",
+              "title": "Customs"
+            },
+            {
+              "const": "delivery",
+              "title": "Delivery"
+            },
+            {
+              "const": "packing",
+              "title": "Packing"
+            },
+            {
+              "const": "handling",
+              "title": "Handling"
+            },
+            {
+              "const": "insurance",
+              "title": "Insurance"
+            },
+            {
+              "const": "storage",
+              "title": "Storage"
+            },
+            {
+              "const": "admin",
+              "title": "Administration"
+            },
+            {
+              "const": "cleaning",
+              "title": "Cleaning"
+            },
+            {
+              "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+              "title": "Other"
+            }
+          ],
+          "title": "Key",
+          "description": "Key for grouping or identifying charges for tax purposes. A suggested list of\nkeys is provided, but these may be extended by the issuer."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code to used to refer to the this charge by the issuer"
+        },
+        "reason": {
+          "type": "string",
+          "title": "Reason",
+          "description": "Text description as to why the charge was applied"
+        },
+        "base": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Base",
+          "description": "Base represents the value used as a base for percent calculations instead\nof the invoice's sum of lines."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percentage to apply to the sum of all lines"
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Amount to apply (calculated if percent present)",
+          "calculated": true
+        },
+        "taxes": {
+          "$ref": "https://gobl.org/draft-0/tax/set",
+          "title": "Taxes",
+          "description": "List of taxes to apply to the charge"
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension codes that apply to the charge"
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional semi-structured information."
+        }
+      },
+      "type": "object",
+      "required": [
+        "i",
+        "amount"
+      ],
+      "description": "Charge represents a surchange applied to the complete document independent from the individual lines."
+    }
+  }
+}

data/data/schemas/bill/correction-options.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/correction-options",
+  "$ref": "#/$defs/CorrectionOptions",
+  "$defs": {
+    "CorrectionOptions": {
+      "properties": {
+        "type": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Type",
+          "description": "The type of corrective invoice to produce."
+        },
+        "issue_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Issue Date",
+          "description": "When the new corrective invoice's issue date should be set to."
+        },
+        "series": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Series",
+          "description": "Series to assign to the new corrective invoice."
+        },
+        "stamps": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/head/stamp"
+          },
+          "type": "array",
+          "title": "Stamps",
+          "description": "Stamps of the previous document to include in the preceding data."
+        },
+        "reason": {
+          "type": "string",
+          "title": "Reason",
+          "description": "Human readable reason for the corrective operation."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extensions for region specific requirements that may be added in the preceding\nor at the document level, according to the local rules."
+        },
+        "copy_tax": {
+          "type": "boolean",
+          "title": "Copy Tax Totals",
+          "description": "CopyTax when true will copy the tax totals from the previous document to the\npreceding document data."
+        }
+      },
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "description": "CorrectionOptions defines a structure used to pass configuration options to correct a previous invoice."
+    }
+  }
+}

data/data/schemas/bill/delivery-details.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/bill/delivery-details",
+  "$ref": "#/$defs/DeliveryDetails",
+  "$defs": {
+    "DeliveryDetails": {
+      "properties": {
+        "receiver": {
+          "$ref": "https://gobl.org/draft-0/org/party",
+          "title": "Receiver",
+          "description": "The party who will receive delivery of the goods defined in the invoice and is not responsible for taxes."
+        },
+        "identities": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/identity"
+          },
+          "type": "array",
+          "title": "Identities",
+          "description": "Identities is used to define specific codes or IDs that may be used to\nidentify the delivery."
+        },
+        "date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Date",
+          "description": "When the goods should be expected."
+        },
+        "period": {
+          "$ref": "https://gobl.org/draft-0/cal/period",
+          "title": "Period",
+          "description": "Period of time in which to expect delivery if a specific date is not available."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional custom data."
+        }
+      },
+      "type": "object",
+      "description": "DeliveryDetails covers the details of the destination for the products described in the invoice body."
+    }
+  }
+}