gobl 0.24.1 → 0.24.3

data/data/schemas/org/item.json

@@ -0,0 +1,96 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/item",
+  "$ref": "#/$defs/Item",
+  "$defs": {
+    "Item": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "ref": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Ref",
+          "description": "Primary reference code that identifies this item.\nAdditional codes can be provided in the 'identities' property."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Special key used to classify the item sometimes required by some regimes."
+        },
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "Brief name of the item"
+        },
+        "identities": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/identity"
+          },
+          "type": "array",
+          "title": "Identities",
+          "description": "List of additional codes, IDs, or SKUs which can be used to identify the item. They should be agreed upon between supplier and customer."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Detailed description of the item."
+        },
+        "images": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/image"
+          },
+          "type": "array",
+          "title": "Images",
+          "description": "Images associated with the item."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "Currency used for the item's price."
+        },
+        "price": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Price",
+          "description": "Base price of a single unit to be sold."
+        },
+        "alt_prices": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/currency/amount"
+          },
+          "type": "array",
+          "title": "Alternative Prices",
+          "description": "AltPrices defines a list of prices with their currencies that may be used\nas an alternative to the item's base price."
+        },
+        "unit": {
+          "$ref": "https://gobl.org/draft-0/org/unit",
+          "title": "Unit",
+          "description": "Unit of measure."
+        },
+        "origin": {
+          "$ref": "https://gobl.org/draft-0/l10n/iso-country-code",
+          "title": "Country of Origin",
+          "description": "Country code of where this item was from originally."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension code map for any additional regime specific codes that may be required."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional meta information that may be useful"
+        }
+      },
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "description": "Item is used to describe a single product or service."
+    }
+  }
+}

data/data/schemas/org/name.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/name",
+  "$ref": "#/$defs/Name",
+  "$defs": {
+    "Name": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "alias": {
+          "type": "string",
+          "title": "Alias",
+          "description": "What the person would like to be called"
+        },
+        "prefix": {
+          "type": "string",
+          "title": "Prefix",
+          "description": "Additional prefix to add to name, like Mrs. or Mr."
+        },
+        "given": {
+          "type": "string",
+          "title": "Given",
+          "description": "Person's given or first name"
+        },
+        "middle": {
+          "type": "string",
+          "title": "Middle",
+          "description": "Middle names or initials"
+        },
+        "surname": {
+          "type": "string",
+          "title": "Surname",
+          "description": "Second or Family name."
+        },
+        "surname2": {
+          "type": "string",
+          "title": "Second Surname",
+          "description": "Additional second of family name."
+        },
+        "suffix": {
+          "type": "string",
+          "title": "Suffix",
+          "description": "Titles to include after the name."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Any additional useful data."
+        }
+      },
+      "type": "object",
+      "description": "Name represents what a human is called."
+    }
+  }
+}

data/data/schemas/org/note.json

@@ -0,0 +1,184 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/note",
+  "$ref": "#/$defs/Note",
+  "$defs": {
+    "Note": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "oneOf": [
+            {
+              "const": "goods",
+              "title": "Goods",
+              "description": "Goods Description"
+            },
+            {
+              "const": "payment",
+              "title": "Payment",
+              "description": "Terms of Payment"
+            },
+            {
+              "const": "legal",
+              "title": "Legal",
+              "description": "Legal or regulatory information"
+            },
+            {
+              "const": "dangerous-goods",
+              "title": "Dangerous Goods",
+              "description": "Dangerous goods additional information"
+            },
+            {
+              "const": "ack",
+              "title": "Acknowledgement",
+              "description": "Acknowledgement Description"
+            },
+            {
+              "const": "rate",
+              "title": "Rate",
+              "description": "Rate additional information"
+            },
+            {
+              "const": "reason",
+              "title": "Reason",
+              "description": "Explanation of something relevant to the document"
+            },
+            {
+              "const": "dispute",
+              "title": "Dispute",
+              "description": "Details on a dispute."
+            },
+            {
+              "const": "customer",
+              "title": "Customer",
+              "description": "Customer remarks"
+            },
+            {
+              "const": "glossary",
+              "title": "Glossary",
+              "description": "Glossary of terms"
+            },
+            {
+              "const": "customs",
+              "title": "Customs",
+              "description": "Customs declaration information"
+            },
+            {
+              "const": "general",
+              "title": "General",
+              "description": "General information"
+            },
+            {
+              "const": "handling",
+              "title": "Handling",
+              "description": "Handling instructions"
+            },
+            {
+              "const": "packaging",
+              "title": "Packaging",
+              "description": "Packaging information"
+            },
+            {
+              "const": "loading",
+              "title": "Loading",
+              "description": "Loading instructions"
+            },
+            {
+              "const": "price",
+              "title": "Price",
+              "description": "Price conditions"
+            },
+            {
+              "const": "priority",
+              "title": "Priority",
+              "description": "Priority information"
+            },
+            {
+              "const": "regulatory",
+              "title": "Regulatory",
+              "description": "Regulatory information"
+            },
+            {
+              "const": "safety",
+              "title": "Safety",
+              "description": "Safety instructions"
+            },
+            {
+              "const": "ship-line",
+              "title": "Ship Line",
+              "description": "Ship line"
+            },
+            {
+              "const": "supplier",
+              "title": "Supplier",
+              "description": "Supplier remarks"
+            },
+            {
+              "const": "transport",
+              "title": "Transport",
+              "description": "Transportation information"
+            },
+            {
+              "const": "delivery",
+              "title": "Delivery",
+              "description": "Delivery information"
+            },
+            {
+              "const": "quarantine",
+              "title": "Quarantine",
+              "description": "Quarantine information"
+            },
+            {
+              "const": "tax",
+              "title": "Tax",
+              "description": "Tax declaration"
+            },
+            {
+              "const": "other",
+              "title": "Other",
+              "description": "Mutually defined"
+            }
+          ],
+          "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"
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional information about the note"
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension data"
+        }
+      },
+      "type": "object",
+      "required": [
+        "text"
+      ],
+      "description": "Note represents a free text of additional information that may be added to a document."
+    }
+  }
+}

data/data/schemas/org/party.json

@@ -0,0 +1,129 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/party",
+  "$ref": "#/$defs/Party",
+  "$defs": {
+    "Party": {
+      "properties": {
+        "$regime": {
+          "$ref": "https://gobl.org/draft-0/l10n/tax-country-code",
+          "title": "Tax Regime"
+        },
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label can be used to provide a custom label for the party in a given\ncontext in a single language, for example \"Supplier\", \"Host\", or similar.",
+          "examples": [
+            "Supplier"
+          ]
+        },
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "Legal name or representation of the organization."
+        },
+        "alias": {
+          "type": "string",
+          "title": "Alias",
+          "description": "Alternate short name."
+        },
+        "tax_id": {
+          "$ref": "https://gobl.org/draft-0/tax/identity",
+          "title": "Tax Identity",
+          "description": "The entity's legal ID code used for tax purposes. They may have other numbers, but we're only interested in those valid for tax purposes."
+        },
+        "identities": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/identity"
+          },
+          "type": "array",
+          "title": "Identities",
+          "description": "Set of codes used to identify the party in other systems."
+        },
+        "people": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/person"
+          },
+          "type": "array",
+          "title": "People",
+          "description": "Details of physical people who represent the party."
+        },
+        "inboxes": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/inbox"
+          },
+          "type": "array",
+          "title": "Inboxes",
+          "description": "Digital inboxes used for forwarding electronic versions of documents"
+        },
+        "addresses": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/address"
+          },
+          "type": "array",
+          "title": "Postal Addresses",
+          "description": "Regular post addresses for where information should be sent if needed."
+        },
+        "emails": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/email"
+          },
+          "type": "array",
+          "title": "Email Addresses",
+          "description": "Electronic mail addresses"
+        },
+        "websites": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/website"
+          },
+          "type": "array",
+          "title": "Websites",
+          "description": "Public websites that provide further information about the party."
+        },
+        "telephones": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/telephone"
+          },
+          "type": "array",
+          "title": "Telephone Numbers",
+          "description": "Regular telephone numbers"
+        },
+        "registration": {
+          "$ref": "https://gobl.org/draft-0/org/registration",
+          "title": "Registration",
+          "description": "Additional registration details about the company that may need to be included in a document."
+        },
+        "logos": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/image"
+          },
+          "type": "array",
+          "title": "Logos",
+          "description": "Images that can be used to identify the party visually."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extension code map for any additional regime specific codes that may be required."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Any additional semi-structured information that does not fit into the rest of the party."
+        }
+      },
+      "type": "object",
+      "description": "Party represents a person or business entity.",
+      "recommended": [
+        "name",
+        "tax_id"
+      ]
+    }
+  }
+}

data/data/schemas/org/person.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/person",
+  "$ref": "#/$defs/Person",
+  "$defs": {
+    "Person": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label can be used to identify the person in a given context in a single\nlanguage, for example \"Attn\", \"Contact\", \"Responsible\", etc.",
+          "examples": [
+            "Attn"
+          ]
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Key used to identify the role of the person inside the context of the object."
+        },
+        "name": {
+          "$ref": "https://gobl.org/draft-0/org/name",
+          "title": "Name",
+          "description": "Complete details on the name of the person."
+        },
+        "role": {
+          "type": "string",
+          "title": "Role",
+          "description": "Role or job title of the responsibilities of the person within an organization."
+        },
+        "identities": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/identity"
+          },
+          "type": "array",
+          "title": "Identities",
+          "description": "Set of codes used to identify the person, such as ID numbers, social security,\ndriving licenses, etc. that can be attributed to the individual."
+        },
+        "addresses": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/address"
+          },
+          "type": "array",
+          "title": "Postal Addresses",
+          "description": "Regular post addresses for where information should be sent if needed."
+        },
+        "emails": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/email"
+          },
+          "type": "array",
+          "title": "Email Addresses",
+          "description": "Electronic mail addresses that belong to the person."
+        },
+        "telephones": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/telephone"
+          },
+          "type": "array",
+          "title": "Telephone Numbers",
+          "description": "Regular phone or mobile numbers"
+        },
+        "avatars": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/org/image"
+          },
+          "type": "array",
+          "title": "Avatars",
+          "description": "Avatars provider links to images or photos or the person."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Data about the data."
+        }
+      },
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "description": "Person represents a human, and how to contact them electronically."
+    }
+  }
+}

data/data/schemas/org/registration.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/registration",
+  "$ref": "#/$defs/Registration",
+  "$defs": {
+    "Registration": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "examples": [
+            "Registration"
+          ]
+        },
+        "capital": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Capital"
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency"
+        },
+        "office": {
+          "type": "string",
+          "title": "Office"
+        },
+        "book": {
+          "type": "string",
+          "title": "Book"
+        },
+        "volume": {
+          "type": "string",
+          "title": "Volume"
+        },
+        "sheet": {
+          "type": "string",
+          "title": "Sheet"
+        },
+        "section": {
+          "type": "string",
+          "title": "Section"
+        },
+        "page": {
+          "type": "string",
+          "title": "Page"
+        },
+        "entry": {
+          "type": "string",
+          "title": "Entry"
+        },
+        "other": {
+          "type": "string",
+          "title": "Other"
+        }
+      },
+      "type": "object",
+      "description": "Registration is used in countries that require additional information to be associated with a company usually related to a specific registration office."
+    }
+  }
+}

data/data/schemas/org/telephone.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/telephone",
+  "$ref": "#/$defs/Telephone",
+  "$defs": {
+    "Telephone": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Identifier for this number."
+        },
+        "num": {
+          "type": "string",
+          "title": "Number",
+          "description": "Free-text string that represents the telephone number."
+        }
+      },
+      "type": "object",
+      "required": [
+        "num"
+      ],
+      "description": "Telephone describes what is expected for a telephone number."
+    }
+  }
+}