gobl 0.24.1 → 0.24.3

data/data/schemas/tax/regime-def.json

@@ -0,0 +1,513 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/tax/regime-def",
+  "$ref": "#/$defs/RegimeDef",
+  "$defs": {
+    "CategoryDef": {
+      "properties": {
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code to be used in documents"
+        },
+        "name": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Name",
+          "description": "Short name of the category to be used instead of code in output"
+        },
+        "title": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Title",
+          "description": "Human name for the code to use for titles"
+        },
+        "desc": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Description",
+          "description": "Useful description of the category."
+        },
+        "retained": {
+          "type": "boolean",
+          "title": "Retained",
+          "description": "Retained when true implies that the tax amount will be retained\nby the buyer on behalf of the supplier, and thus subtracted from\nthe invoice taxable base total. Typically used for taxes related to\nincome."
+        },
+        "informative": {
+          "type": "boolean",
+          "title": "Informative",
+          "description": "Informative when true implies that the tax amount will be calculated\nand reported but will not affect the invoice totals. Typically used\nfor taxes that are embedded in the base amount or don't impact the\nfinal payable amount."
+        },
+        "keys": {
+          "items": {
+            "$ref": "#/$defs/KeyDef"
+          },
+          "type": "array",
+          "title": "Keys",
+          "description": "Specific tax definitions inside this category."
+        },
+        "rates": {
+          "items": {
+            "$ref": "#/$defs/RateDef"
+          },
+          "type": "array",
+          "title": "Rates",
+          "description": "Rates defines the set of rates that can be used with this category."
+        },
+        "extensions": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Extensions",
+          "description": "Extensions defines a list of extension keys that may be used or required\nas an alternative or alongside choosing a rate for the tax category.\nEvery key must be defined in the Regime's extensions table."
+        },
+        "map": {
+          "$ref": "https://gobl.org/draft-0/cbc/code-map",
+          "title": "Map",
+          "description": "Map defines a set of regime specific code mappings."
+        },
+        "sources": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/source"
+          },
+          "type": "array",
+          "title": "Sources",
+          "description": "List of sources for the information contained in this category."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension key-value pairs that will be copied to the tax combo if this\ncategory is used."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Meta contains additional information about the category that is relevant\nfor local frequently used formats."
+        }
+      },
+      "type": "object",
+      "required": [
+        "code",
+        "name"
+      ],
+      "description": "CategoryDef contains the definition of a general type of tax inside a region."
+    },
+    "CorrectionDefinition": {
+      "properties": {
+        "schema": {
+          "type": "string",
+          "title": "Schema",
+          "description": "Partial or complete schema URL for the document type supported by correction."
+        },
+        "types": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Types",
+          "description": "The types of sub-documents supported by the regime"
+        },
+        "extensions": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Extensions",
+          "description": "Extension keys that can be included"
+        },
+        "reason_required": {
+          "type": "boolean",
+          "title": "Reason Required",
+          "description": "ReasonRequired when true implies that a reason must be provided"
+        },
+        "stamps": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Stamps",
+          "description": "Stamps that must be copied from the preceding document."
+        },
+        "copy_tax": {
+          "type": "boolean",
+          "title": "Copy Tax Totals",
+          "description": "Copy tax from the preceding document to the document ref."
+        }
+      },
+      "type": "object",
+      "required": [
+        "schema"
+      ],
+      "description": "CorrectionDefinition contains details about what can be defined in ."
+    },
+    "CorrectionSet": {
+      "items": {
+        "$ref": "#/$defs/CorrectionDefinition"
+      },
+      "type": "array",
+      "description": "CorrectionSet defines a set of correction definitions for a selection of schemas."
+    },
+    "KeyDef": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Key identifies this rate within the system"
+        },
+        "name": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Name",
+          "description": "Human name of the rate set"
+        },
+        "desc": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Description",
+          "description": "Useful description of the rate."
+        },
+        "no_percent": {
+          "type": "boolean",
+          "title": "No Percent",
+          "description": "NoPercent when true implies that the rate when used in a tax Combo should\nnot define a percent value."
+        }
+      },
+      "type": "object",
+      "description": "KeyDef defines a key that can be used inside a tax category."
+    },
+    "RateDef": {
+      "properties": {
+        "rate": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Rate",
+          "description": "Rate defines the key for which this rate applies."
+        },
+        "keys": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Keys",
+          "description": "Keys identifies the set of tax keys defined in the category that this\nrate can be used with."
+        },
+        "name": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Name",
+          "description": "Human name of the rate"
+        },
+        "desc": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Description",
+          "description": "Useful description of the rate."
+        },
+        "values": {
+          "items": {
+            "$ref": "#/$defs/RateValueDef"
+          },
+          "type": "array",
+          "title": "Values",
+          "description": "Values contains a list of Value objects that contain the\ncurrent and historical percentage values for the rate and\nadditional filters.\nOrder is important, newer values should come before\nolder values."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Meta contains additional information about the rate that is relevant\nfor local frequently used implementations."
+        }
+      },
+      "type": "object",
+      "required": [
+        "rate",
+        "name"
+      ],
+      "description": "RateDef defines a single rate inside a category"
+    },
+    "RateValueDef": {
+      "properties": {
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Only apply this rate if one of the tags is present in the invoice.\nTags []cbc.Key `json:\"tags,omitempty\" jsonschema:\"title=Tags\"`\nExt map of keys that can be used to filter to determine if the rate applies."
+        },
+        "since": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Since",
+          "description": "Date from which this value should be applied."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percent rate that should be applied"
+        },
+        "surcharge": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Surcharge",
+          "description": "An additional surcharge to apply."
+        },
+        "disabled": {
+          "type": "boolean",
+          "title": "Disabled",
+          "description": "When true, this value should no longer be used."
+        }
+      },
+      "type": "object",
+      "required": [
+        "percent"
+      ],
+      "description": "RateValueDef contains a percentage rate or fixed amount for a given date range."
+    },
+    "RegimeDef": {
+      "properties": {
+        "name": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Name",
+          "description": "Name of the tax regime."
+        },
+        "description": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Description",
+          "description": "Introductory details about the regime."
+        },
+        "time_zone": {
+          "type": "string",
+          "title": "Time Zone",
+          "description": "Location name for the country's central time zone. Accepted\nvalues from IANA Time Zone Database (https://iana.org/time-zones)."
+        },
+        "country": {
+          "$ref": "https://gobl.org/draft-0/l10n/tax-country-code",
+          "title": "Code",
+          "description": "Country code for the region"
+        },
+        "alt_country_codes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/l10n/code"
+          },
+          "type": "array",
+          "title": "Alternative Country Codes",
+          "description": "Alternative localization codes that may be used to identify the tax regime\nin specific circumstances."
+        },
+        "zone": {
+          "$ref": "https://gobl.org/draft-0/l10n/code",
+          "title": "Zone",
+          "description": "Specific Locality, region, city, province, county, or similar code inside\nthe country, if needed."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "Currency used by the country."
+        },
+        "tax_scheme": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Tax Scheme",
+          "description": "TaxScheme defines the principal scheme of consumption tax that should be\napplied to the regime and associated with Tax IDs in some export formats\nsuch as UBL or CII. Some regimes may not have a Tax Scheme and as a\nconsequence will not use tax identities, like the US."
+        },
+        "calculator_rounding_rule": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Calculator Rounding Rule",
+          "description": "Rounding rule to use when calculating the tax totals, default is always\n`sum-then-round`."
+        },
+        "tags": {
+          "items": {
+            "$ref": "#/$defs/TagSet"
+          },
+          "type": "array",
+          "title": "Tags",
+          "description": "Tags that can be applied at the document level to identify additional\nconsiderations."
+        },
+        "extensions": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/definition"
+          },
+          "type": "array",
+          "title": "Extensions",
+          "description": "Extensions defines the keys that can be used for extended or extra data inside the regime that\nis specific to the regime and cannot be easily determined from other GOBL structures.\nTypically these are used to define local codes for suppliers, customers, products, or tax rates."
+        },
+        "identities": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/definition"
+          },
+          "type": "array",
+          "title": "Identities",
+          "description": "Identities used in addition to regular tax identities and specific for the\nregime that may be validated against."
+        },
+        "payment_means_keys": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/definition"
+          },
+          "type": "array",
+          "title": "Payment Means Keys",
+          "description": "PaymentMeansKeys specific for the regime that extend the original\nbase payment means keys."
+        },
+        "inbox_keys": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/definition"
+          },
+          "type": "array",
+          "title": "Inbox Keys",
+          "description": "InboxKeys specific to the regime that can be used to identify where a document\nshould be forwarded to."
+        },
+        "scenarios": {
+          "items": {
+            "$ref": "#/$defs/ScenarioSet"
+          },
+          "type": "array",
+          "title": "Scenarios"
+        },
+        "corrections": {
+          "$ref": "#/$defs/CorrectionSet",
+          "title": "Corrections",
+          "description": "Configuration details for corrections to be used with correction options."
+        },
+        "categories": {
+          "items": {
+            "$ref": "#/$defs/CategoryDef"
+          },
+          "type": "array",
+          "title": "Categories",
+          "description": "List of tax categories."
+        }
+      },
+      "type": "object",
+      "required": [
+        "name",
+        "time_zone",
+        "country",
+        "currency",
+        "categories"
+      ],
+      "description": "RegimeDef defines the holding structure for the definitions of taxes inside a country or territory."
+    },
+    "Scenario": {
+      "properties": {
+        "name": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Name",
+          "description": "Name of the scenario for further information."
+        },
+        "desc": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Description",
+          "description": "Description of the scenario for documentation purposes."
+        },
+        "type": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Type",
+          "description": "Type of document, if present."
+        },
+        "tags": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/key"
+          },
+          "type": "array",
+          "title": "Tags",
+          "description": "Array of tags that have been applied to the document."
+        },
+        "ext_key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Extension Key",
+          "description": "Extension key that must be present in the document."
+        },
+        "ext_code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Extension Code",
+          "description": "Extension code that along side the key must be present for a match\nto happen. This cannot be used without an `cbc.Code`. The value will\nbe copied to the note code if needed."
+        },
+        "note": {
+          "$ref": "#/$defs/ScenarioNote",
+          "title": "Note",
+          "description": "A note to be added to the document if the scenario is applied."
+        },
+        "codes": {
+          "$ref": "https://gobl.org/draft-0/cbc/code-map",
+          "title": "Codes",
+          "description": "Codes is used to define additional codes for regime specific\nsituations."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Ext represents a set of tax extensions that should be applied to\nthe document in the appropriate \"tax\" context."
+        }
+      },
+      "type": "object",
+      "description": "Scenario is used to describe a tax scenario of a document based on the combination of document type and tag used."
+    },
+    "ScenarioNote": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Key specifying subject of the text"
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code used for additional data that may be required to identify the note."
+        },
+        "src": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Source",
+          "description": "Source of this note, especially useful when auto-generated."
+        },
+        "text": {
+          "type": "string",
+          "title": "Text",
+          "description": "The contents of the note"
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension data"
+        }
+      },
+      "type": "object",
+      "required": [
+        "text"
+      ],
+      "description": "ScenarioNote represents the structure of the note that needs to be added to the document."
+    },
+    "ScenarioSet": {
+      "properties": {
+        "schema": {
+          "type": "string",
+          "title": "Schema",
+          "description": "Partial or complete schema URL for the document type"
+        },
+        "list": {
+          "items": {
+            "$ref": "#/$defs/Scenario"
+          },
+          "type": "array",
+          "title": "List",
+          "description": "List of scenarios for the schema"
+        }
+      },
+      "type": "object",
+      "required": [
+        "schema",
+        "list"
+      ],
+      "description": "ScenarioSet is a collection of tax scenarios for a given schema that can be used to determine special codes or notes that need to be included in the final document."
+    },
+    "TagSet": {
+      "properties": {
+        "schema": {
+          "type": "string",
+          "title": "Schema",
+          "description": "Schema that the tags are associated with."
+        },
+        "list": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/definition"
+          },
+          "type": "array",
+          "title": "List",
+          "description": "List of tags for the schema"
+        }
+      },
+      "type": "object",
+      "required": [
+        "schema",
+        "list"
+      ],
+      "description": "TagSet defines a set of tags and their descriptions that can be used for a specific schema in the context of a Regime or Addon."
+    }
+  }
+}

data/data/schemas/tax/set.json

@@ -0,0 +1,139 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/tax/set",
+  "$ref": "#/$defs/Set",
+  "$defs": {
+    "Combo": {
+      "anyOf": [
+        {
+          "if": {
+            "properties": {
+              "cat": {
+                "const": "VAT"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "key": {
+                "oneOf": [
+                  {
+                    "const": "standard",
+                    "title": "Standard"
+                  },
+                  {
+                    "const": "zero",
+                    "title": "Zero"
+                  },
+                  {
+                    "const": "reverse-charge",
+                    "title": "Reverse charge"
+                  },
+                  {
+                    "const": "exempt",
+                    "title": "Exempt"
+                  },
+                  {
+                    "const": "export",
+                    "title": "Export"
+                  },
+                  {
+                    "const": "intra-community",
+                    "title": "Intra-community"
+                  },
+                  {
+                    "const": "outside-scope",
+                    "title": "Outside scope"
+                  }
+                ]
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "cat": {
+                "const": "GST"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "key": {
+                "oneOf": [
+                  {
+                    "const": "standard",
+                    "title": "Standard"
+                  },
+                  {
+                    "const": "zero",
+                    "title": "Zero"
+                  },
+                  {
+                    "const": "exempt",
+                    "title": "Exempt"
+                  },
+                  {
+                    "const": "outside-scope",
+                    "title": "Outside scope"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      ],
+      "properties": {
+        "cat": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Category",
+          "description": "Tax category code from those available inside a region."
+        },
+        "country": {
+          "$ref": "https://gobl.org/draft-0/l10n/tax-country-code",
+          "title": "Country",
+          "description": "Country code override when issuing with taxes applied from different countries."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "description": "Key helps determine the tax situation within the category."
+        },
+        "rate": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Rate",
+          "description": "Rate within a category and for a given key to apply."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percent defines the percentage set manually or determined from the\nkey. A nil percent implies that this tax combo is either exempt or not-subject.",
+          "calculated": true
+        },
+        "surcharge": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Surcharge",
+          "description": "Some countries require an additional surcharge (may be determined if key present).",
+          "calculated": true
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Local codes that apply for a given rate or percentage that need to be identified and validated."
+        }
+      },
+      "type": "object",
+      "required": [
+        "cat"
+      ],
+      "description": "Combo represents the tax combination of a category code and rate key."
+    },
+    "Set": {
+      "items": {
+        "$ref": "#/$defs/Combo"
+      },
+      "type": "array",
+      "description": "Set defines a list of tax categories and their rates to be used alongside taxable items."
+    }
+  }
+}