gobl 0.24.1 → 0.24.3

data/data/schemas/org/unit.json

@@ -0,0 +1,350 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/unit",
+  "$ref": "#/$defs/Unit",
+  "$defs": {
+    "Unit": {
+      "oneOf": [
+        {
+          "const": "mg",
+          "title": "Milligrams"
+        },
+        {
+          "const": "g",
+          "title": "Metric grams"
+        },
+        {
+          "const": "kg",
+          "title": "Metric kilograms"
+        },
+        {
+          "const": "t",
+          "title": "Metric tons"
+        },
+        {
+          "const": "mm",
+          "title": "Milimetres"
+        },
+        {
+          "const": "cm",
+          "title": "Centimetres"
+        },
+        {
+          "const": "dm",
+          "title": "Decimetres",
+          "description": "A unit of length equal to one-tenth of a metre."
+        },
+        {
+          "const": "m",
+          "title": "Metres"
+        },
+        {
+          "const": "km",
+          "title": "Kilometers"
+        },
+        {
+          "const": "in",
+          "title": "Inches"
+        },
+        {
+          "const": "ft",
+          "title": "Feet"
+        },
+        {
+          "const": "mm2",
+          "title": "Square millimetres"
+        },
+        {
+          "const": "cm2",
+          "title": "Square centimetres"
+        },
+        {
+          "const": "dm2",
+          "title": "Square decimetres"
+        },
+        {
+          "const": "m2",
+          "title": "Square metres"
+        },
+        {
+          "const": "ac",
+          "title": "Acres",
+          "description": "A unit of area equal to 43,560 square feet."
+        },
+        {
+          "const": "ha",
+          "title": "Hectares",
+          "description": "A unit of area equal to 10,000 square metres."
+        },
+        {
+          "const": "mm3",
+          "title": "Cubic millimetres"
+        },
+        {
+          "const": "cm3",
+          "title": "Cubic centimetres"
+        },
+        {
+          "const": "dm3",
+          "title": "Cubic decimetres"
+        },
+        {
+          "const": "m3",
+          "title": "Cubic metres"
+        },
+        {
+          "const": "ml",
+          "title": "Millilitres"
+        },
+        {
+          "const": "cl",
+          "title": "Centilitres"
+        },
+        {
+          "const": "l",
+          "title": "Litres"
+        },
+        {
+          "const": "w",
+          "title": "Watts"
+        },
+        {
+          "const": "kw",
+          "title": "Kilowatts"
+        },
+        {
+          "const": "kwh",
+          "title": "Kilowatt Hours"
+        },
+        {
+          "const": "rate",
+          "title": "Rate",
+          "description": "A unit of quantity expressed as a rate for usage of a facility or service."
+        },
+        {
+          "const": "mon",
+          "title": "Months",
+          "description": "Unit of time equal to 1/12 of a year of 365,25 days."
+        },
+        {
+          "const": "day",
+          "title": "Days"
+        },
+        {
+          "const": "s",
+          "title": "Seconds"
+        },
+        {
+          "const": "h",
+          "title": "Hours"
+        },
+        {
+          "const": "min",
+          "title": "Minutes"
+        },
+        {
+          "const": "piece",
+          "title": "Pieces",
+          "description": "A unit of count defining the number of pieces (piece: a single item, article or exemplar)."
+        },
+        {
+          "const": "item",
+          "title": "Items",
+          "description": " A unit of count defining the number of items regarded as separate units."
+        },
+        {
+          "const": "pair",
+          "title": "Pairs",
+          "description": "A unit of count defining the number of pairs (pair: item described by two's)."
+        },
+        {
+          "const": "dozen",
+          "title": "Dozens",
+          "description": "A unit of count defining the number of units in multiples of 12."
+        },
+        {
+          "const": "assortment",
+          "title": "Assortments",
+          "description": "A unit of count defining the number of assortments (assortment: a collection of items or components of a single product packaged together)."
+        },
+        {
+          "const": "service",
+          "title": "Service Units",
+          "description": "A unit of count defining the number of service units (service unit: defined period / property / facility / utility of supply)."
+        },
+        {
+          "const": "job",
+          "title": "Jobs",
+          "description": "A unit of count defining the number of jobs."
+        },
+        {
+          "const": "activity",
+          "title": "Activities",
+          "description": "A unit of count defining the number of activities (activity: a unit of work or action)."
+        },
+        {
+          "const": "trip",
+          "title": "Trips",
+          "description": "A unit of count defining the number of trips (trip: a journey to a place and back again)."
+        },
+        {
+          "const": "group",
+          "title": "Groups",
+          "description": "A unit of count defining the number of groups (group: set of items classified together)."
+        },
+        {
+          "const": "outfit",
+          "title": "Outfits",
+          "description": "A unit of count defining the number of outfits (outfit: a complete set of equipment / materials / objects used for a specific purpose)."
+        },
+        {
+          "const": "kit",
+          "title": "Kits",
+          "description": "A unit of count defining the number of kits (kit: tub, barrel or pail)."
+        },
+        {
+          "const": "basebox",
+          "title": "Base Boxes",
+          "description": "A unit of area of 112 sheets of tin mil products (tin plate, tin free steel or black plate) 14 by 20 inches, or 31,360 square inches."
+        },
+        {
+          "const": "pk",
+          "title": "Bulk Packs",
+          "description": "A unit of count defining the number of items per bulk pack."
+        },
+        {
+          "const": "one",
+          "title": "One",
+          "description": "A single generic unit of a service or product."
+        },
+        {
+          "const": "bag",
+          "title": "Bags"
+        },
+        {
+          "const": "box",
+          "title": "Boxes"
+        },
+        {
+          "const": "bin",
+          "title": "Bins"
+        },
+        {
+          "const": "can",
+          "title": "Cans"
+        },
+        {
+          "const": "tub",
+          "title": "Tubs"
+        },
+        {
+          "const": "case",
+          "title": "Cases"
+        },
+        {
+          "const": "tray",
+          "title": "Trays"
+        },
+        {
+          "const": "portion",
+          "title": "Portions"
+        },
+        {
+          "const": "set",
+          "title": "Sets",
+          "description": "A unit of count defining the number of sets (set: a number of objects grouped together)."
+        },
+        {
+          "const": "roll",
+          "title": "Rolls"
+        },
+        {
+          "const": "carton",
+          "title": "Cartons"
+        },
+        {
+          "const": "cylinder",
+          "title": "Cylinders"
+        },
+        {
+          "const": "barrel",
+          "title": "Barrels"
+        },
+        {
+          "const": "jerrican",
+          "title": "Jerricans",
+          "description": "Jerrican, cylindrical"
+        },
+        {
+          "const": "carboy",
+          "title": "Carboys"
+        },
+        {
+          "const": "demijohn",
+          "title": "Demijohn"
+        },
+        {
+          "const": "bottle",
+          "title": "Bottles"
+        },
+        {
+          "const": "6pack",
+          "title": "Six Packs"
+        },
+        {
+          "const": "canister",
+          "title": "Canisters"
+        },
+        {
+          "const": "pkg",
+          "title": "Packages",
+          "description": "Standard packaging unit."
+        },
+        {
+          "const": "bunch",
+          "title": "Bunches"
+        },
+        {
+          "const": "tetrabrik",
+          "title": "Tetra-Briks"
+        },
+        {
+          "const": "pallet",
+          "title": "Pallets"
+        },
+        {
+          "const": "reel",
+          "title": "Reels"
+        },
+        {
+          "const": "sack",
+          "title": "Sacks"
+        },
+        {
+          "const": "sheet",
+          "title": "Sheets"
+        },
+        {
+          "const": "envelope",
+          "title": "Envelopes"
+        },
+        {
+          "const": "lot",
+          "title": "Lot"
+        },
+        {
+          "const": "unit",
+          "title": "Unit",
+          "description": "A type of package composed of a single item or object, not otherwise specified as a unit of transport equipment."
+        },
+        {
+          "pattern": "^[A-Z0-9]{2,3}$",
+          "description": "UN/ECE Unit Code from Recommendations 20 and 21"
+        }
+      ],
+      "type": "string",
+      "title": "Unit",
+      "description": "Unit defines how the quantity of the product should be interpreted either using a GOBL lower-case key (e.g. 'kg'), or UN/ECE code upper-case code (e.g. 'KGM')."
+    }
+  }
+}

data/data/schemas/org/website.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/website",
+  "$ref": "#/$defs/Website",
+  "$defs": {
+    "Website": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label for the website to show alongside the URL."
+        },
+        "title": {
+          "type": "string",
+          "title": "Title",
+          "description": "Title of the website to help distinguish between this and other links."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "title": "URL",
+          "description": "URL for the website."
+        }
+      },
+      "type": "object",
+      "required": [
+        "url"
+      ],
+      "description": "Website describes what is expected for a web address."
+    }
+  }
+}

data/data/schemas/pay/advance.json

@@ -0,0 +1,211 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/pay/advance",
+  "$ref": "#/$defs/Advance",
+  "$defs": {
+    "Advance": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Date",
+          "description": "When the advance was made."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "anyOf": [
+            {
+              "const": "any",
+              "title": "Any",
+              "description": "Any method available, no preference."
+            },
+            {
+              "const": "card",
+              "title": "Card",
+              "description": "Payment card."
+            },
+            {
+              "const": "credit-transfer",
+              "title": "Credit Transfer",
+              "description": "Sender initiated bank or wire transfer."
+            },
+            {
+              "const": "credit-transfer+sepa",
+              "title": "SEPA Credit Transfer",
+              "description": "Sender initiated bank or wire transfer via SEPA."
+            },
+            {
+              "const": "debit-transfer",
+              "title": "Debit Transfer",
+              "description": "Receiver initiated bank or wire transfer."
+            },
+            {
+              "const": "cash",
+              "title": "Cash",
+              "description": "Cash in hand."
+            },
+            {
+              "const": "cheque",
+              "title": "Cheque",
+              "description": "Cheque from bank."
+            },
+            {
+              "const": "bank-draft",
+              "title": "Draft",
+              "description": "Bankers Draft or Bank Cheque."
+            },
+            {
+              "const": "direct-debit",
+              "title": "Direct Debit",
+              "description": "Direct debit from the customers bank account."
+            },
+            {
+              "const": "direct-debit+sepa",
+              "title": "SEPA Direct Debit",
+              "description": "Direct debit from the customers bank account via SEPA."
+            },
+            {
+              "const": "online",
+              "title": "Online",
+              "description": "Online or web payment."
+            },
+            {
+              "const": "promissory-note",
+              "title": "Promissory Note",
+              "description": "Promissory note contract."
+            },
+            {
+              "const": "netting",
+              "title": "Netting",
+              "description": "Intercompany clearing or clearing between partners."
+            },
+            {
+              "const": "other",
+              "title": "Other",
+              "description": "Other or mutually defined means of payment."
+            },
+            {
+              "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+              "title": "Regime Specific Key"
+            }
+          ],
+          "title": "Key",
+          "description": "The payment means used to make the advance."
+        },
+        "ref": {
+          "type": "string",
+          "title": "Reference",
+          "description": "ID or reference for the advance."
+        },
+        "grant": {
+          "type": "boolean",
+          "title": "Grant",
+          "description": "If this \"advance\" payment has come from a public grant or subsidy, set this to true."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Details about the advance."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percentage of the total amount payable that was paid. Note that\nmultiple advances with percentages may lead to rounding errors,\nespecially when the total advances sums to 100%. We recommend only\nincluding one advance with a percent value per document."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "How much was paid."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "If different from the parent document's base currency."
+        },
+        "card": {
+          "$ref": "#/$defs/Card",
+          "title": "Card",
+          "description": "Details of the payment that was made via a credit or debit card."
+        },
+        "credit_transfer": {
+          "$ref": "#/$defs/CreditTransfer",
+          "title": "Credit Transfer",
+          "description": "Details about how the payment was made by credit (bank) transfer."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Tax extensions required by tax regimes or addons."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional details useful for the parties involved."
+        }
+      },
+      "type": "object",
+      "required": [
+        "description",
+        "amount"
+      ],
+      "description": "Advance represents a single payment that has been made already, such as a deposit on an intent to purchase, or as credit from a previous invoice which was later corrected or cancelled."
+    },
+    "Card": {
+      "properties": {
+        "first6": {
+          "type": "string",
+          "title": "First 6",
+          "description": "First 6 digits of the card's Primary Account Number (PAN)."
+        },
+        "last4": {
+          "type": "string",
+          "title": "Last 4",
+          "description": "Last 4 digits of the card's Primary Account Number (PAN)."
+        },
+        "holder": {
+          "type": "string",
+          "title": "Holder Name",
+          "description": "Name of the person whom the card belongs to."
+        }
+      },
+      "type": "object",
+      "description": "Card contains simplified card holder data as a reference for the customer."
+    },
+    "CreditTransfer": {
+      "properties": {
+        "iban": {
+          "type": "string",
+          "title": "IBAN",
+          "description": "International Bank Account Number"
+        },
+        "bic": {
+          "type": "string",
+          "title": "BIC",
+          "description": "Bank Identifier Code used for international transfers."
+        },
+        "number": {
+          "type": "string",
+          "title": "Number",
+          "description": "Account number, if IBAN not available."
+        },
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "Name of the bank."
+        },
+        "branch": {
+          "$ref": "https://gobl.org/draft-0/org/address",
+          "title": "Branch",
+          "description": "Bank office branch address, not normally required."
+        }
+      },
+      "type": "object",
+      "description": "CreditTransfer contains fields that can be used for making payments via a bank transfer or wire."
+    }
+  }
+}