gobl 0.24.1 → 0.24.3

data/data/schemas/note/message.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/note/message",
+  "$ref": "#/$defs/Message",
+  "$defs": {
+    "Message": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "title": {
+          "type": "string",
+          "title": "Title",
+          "description": "Summary of the message content"
+        },
+        "content": {
+          "type": "string",
+          "title": "Content",
+          "description": "Details of what exactly this message wants to communicate."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta Data",
+          "description": "Any additional semi-structured data that might be useful."
+        }
+      },
+      "type": "object",
+      "required": [
+        "content"
+      ],
+      "description": "Message represents a simple message object with a title and some content meant.",
+      "examples": [
+        {
+          "content": "This is an example message.",
+          "title": "Example Title"
+        }
+      ]
+    }
+  }
+}

data/data/schemas/num/amount.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/num/amount",
+  "$ref": "#/$defs/Amount",
+  "$defs": {
+    "Amount": {
+      "type": "string",
+      "pattern": "^\\-?[0-9]+(\\.[0-9]+)?$",
+      "title": "Amount",
+      "description": "Quantity with optional decimal places that determine accuracy."
+    }
+  }
+}

data/data/schemas/num/percentage.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/num/percentage",
+  "$ref": "#/$defs/Percentage",
+  "$defs": {
+    "Percentage": {
+      "type": "string",
+      "pattern": "^\\-?[0-9]+(\\.[0-9]+)?%$",
+      "title": "Percentage",
+      "description": "Similar to an Amount, but designed for percentages and includes % symbol in JSON output."
+    }
+  }
+}

data/data/schemas/org/address.json

@@ -0,0 +1,105 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/address",
+  "$ref": "#/$defs/Address",
+  "$defs": {
+    "Address": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Useful identifier, such as home, work, etc.",
+          "examples": [
+            "Office"
+          ]
+        },
+        "po_box": {
+          "type": "string",
+          "title": "Post Office Box",
+          "description": "Box number or code for the post office box located at the address."
+        },
+        "num": {
+          "type": "string",
+          "title": "Number",
+          "description": "House or building number in the street."
+        },
+        "floor": {
+          "type": "string",
+          "title": "Floor",
+          "description": "Floor number within the building."
+        },
+        "block": {
+          "type": "string",
+          "title": "Block",
+          "description": "Block number within the building."
+        },
+        "door": {
+          "type": "string",
+          "title": "Door",
+          "description": "Door number within the building."
+        },
+        "street": {
+          "type": "string",
+          "title": "Street",
+          "description": "First line of street."
+        },
+        "street_extra": {
+          "type": "string",
+          "title": "Extended Street",
+          "description": "Additional street address details."
+        },
+        "locality": {
+          "type": "string",
+          "title": "Locality",
+          "description": "Name of a village, town, district, or city, typically inside a region."
+        },
+        "region": {
+          "type": "string",
+          "title": "Region",
+          "description": "Name of a city, province, county, or state, inside a country."
+        },
+        "state": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "State",
+          "description": "State or province code for countries that require it."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Post or ZIP code."
+        },
+        "country": {
+          "$ref": "https://gobl.org/draft-0/l10n/iso-country-code",
+          "title": "Country",
+          "description": "ISO country code."
+        },
+        "coords": {
+          "$ref": "https://gobl.org/draft-0/org/coordinates",
+          "title": "Coordinates",
+          "description": "When the postal address is not sufficient, coordinates help locate the address more precisely."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Any additional semi-structure details about the address."
+        }
+      },
+      "type": "object",
+      "description": "Address defines a globally acceptable set of attributes that describes a postal or fiscal address.",
+      "recommended": [
+        "number",
+        "street",
+        "locality",
+        "region",
+        "code",
+        "country"
+      ]
+    }
+  }
+}

data/data/schemas/org/attachment.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/attachment",
+  "$ref": "#/$defs/Attachment",
+  "$defs": {
+    "Attachment": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Key used to identify the attachment inside the document."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code used to identify the payload of the attachment."
+        },
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "Filename of the attachment."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Details of why the attachment is being included and details on\nwhat it contains."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "title": "URL",
+          "description": "URL of where to find the attachment. Prefer using this field\nover the Data field."
+        },
+        "digest": {
+          "$ref": "https://gobl.org/draft-0/dsig/digest",
+          "title": "Digest",
+          "description": "Digest is used to verify the integrity of the attachment\nwhen downloaded from the URL."
+        },
+        "mime": {
+          "type": "string",
+          "title": "MIME Type",
+          "description": "MIME type of the attachment."
+        }
+      },
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "description": "An Attachment provides a structure to be used to attach documents inside a GOBL document, either as a reference via a URL, or directly as a base64 encoded string."
+    }
+  }
+}

data/data/schemas/org/coordinates.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/coordinates",
+  "$ref": "#/$defs/Coordinates",
+  "$defs": {
+    "Coordinates": {
+      "properties": {
+        "lat": {
+          "type": "number",
+          "title": "Latitude",
+          "description": "Decimal latitude coordinate."
+        },
+        "lon": {
+          "type": "number",
+          "title": "Longitude",
+          "description": "Decimal longitude coordinate."
+        },
+        "w3w": {
+          "type": "string",
+          "title": "What 3 Words",
+          "description": "What 3 Words text coordinates."
+        },
+        "geohash": {
+          "type": "string",
+          "title": "Geohash",
+          "description": "Single string coordinate based on geohash standard."
+        }
+      },
+      "type": "object",
+      "description": "Coordinates describes an exact geographical location in the world."
+    }
+  }
+}

data/data/schemas/org/document-ref.json

@@ -0,0 +1,117 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/document-ref",
+  "$ref": "#/$defs/DocumentRef",
+  "$defs": {
+    "DocumentRef": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "schema": {
+          "type": "string",
+          "title": "Schema",
+          "description": "Schema of the referenced document if different from that of the parent."
+        },
+        "type": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Type",
+          "description": "Type of the document referenced according to the defined schema or that of the\nparent document."
+        },
+        "issue_date": {
+          "$ref": "https://gobl.org/draft-0/cal/date",
+          "title": "Issue Date",
+          "description": "IssueDate reflects the date the document was issued."
+        },
+        "series": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Series",
+          "description": "Series the referenced document belongs to."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Source document's code or other identifier."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "Currency used in the document, if different from the parent's currency."
+        },
+        "lines": {
+          "items": {
+            "type": "integer"
+          },
+          "type": "array",
+          "title": "Lines",
+          "description": "Line index numbers inside the document, if relevant."
+        },
+        "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 document or its contents, agreed upon by the supplier and customer."
+        },
+        "period": {
+          "$ref": "https://gobl.org/draft-0/cal/period",
+          "title": "Period",
+          "description": "Tax period in which the referred document had an effect required by some tax regimes and formats."
+        },
+        "reason": {
+          "type": "string",
+          "title": "Reason",
+          "description": "Human readable description on why this reference is here or needs to be used."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Additional details about the document."
+        },
+        "stamps": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/head/stamp"
+          },
+          "type": "array",
+          "title": "Stamps",
+          "description": "Seals of approval from other organizations that may need to be listed."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "title": "URL",
+          "description": "Link to the source document."
+        },
+        "tax": {
+          "$ref": "https://gobl.org/draft-0/tax/total",
+          "title": "Tax",
+          "description": "Tax total breakdown from the original document in the provided currency. Should\nonly be included if required by a specific tax regime or addon."
+        },
+        "payable": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Payable",
+          "description": "Payable is the total amount that is payable in the referenced document. Only needed\nfor specific tax regimes or addons. This may also be used in some scenarios\nto determine the proportion of the referenced document that has been paid, and\ncalculate the remaining amount due and taxes."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Extensions for additional codes that may be required."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Meta contains additional information about the document."
+        }
+      },
+      "type": "object",
+      "required": [
+        "code"
+      ],
+      "description": "DocumentRef is used to describe an existing document or a specific part of it's contents."
+    }
+  }
+}

data/data/schemas/org/email.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/email",
+  "$ref": "#/$defs/Email",
+  "$defs": {
+    "Email": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Identifier for the email."
+        },
+        "addr": {
+          "type": "string",
+          "title": "Address",
+          "description": "Electronic mailing address."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional fields."
+        }
+      },
+      "type": "object",
+      "required": [
+        "addr"
+      ],
+      "description": "Email describes the electronic mailing details."
+    }
+  }
+}

data/data/schemas/org/identity.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/identity",
+  "$ref": "#/$defs/Identity",
+  "$defs": {
+    "Identity": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Optional label useful for non-standard identities to give a bit more context."
+        },
+        "country": {
+          "$ref": "https://gobl.org/draft-0/l10n/iso-country-code",
+          "title": "Country",
+          "description": "Country from which the identity was issued."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Uniquely classify this identity using a key instead of a type."
+        },
+        "type": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Type",
+          "description": "The type of Code being represented and usually specific for\na particular context, country, or tax regime, and cannot be used\nalongside the key."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "The actual value of the identity code."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Description adds details about what the code could mean or imply"
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "Ext provides a way to add additional information to the identity."
+        }
+      },
+      "type": "object",
+      "required": [
+        "code"
+      ],
+      "description": "Identity is used to define a code for a specific context."
+    }
+  }
+}

data/data/schemas/org/image.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/image",
+  "$ref": "#/$defs/Image",
+  "$defs": {
+    "Image": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label to help identify the image."
+        },
+        "url": {
+          "type": "string",
+          "title": "URL",
+          "description": "URL of the image"
+        },
+        "data": {
+          "type": "string",
+          "contentEncoding": "base64",
+          "title": "Data",
+          "description": "As an alternative to the URL and only when the source data is small,\nlike an SVG, the raw data may be provided using Base64 encoding."
+        },
+        "mime": {
+          "type": "string",
+          "title": "MIME",
+          "description": "Format of the image."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Details of what the image represents."
+        },
+        "alt": {
+          "type": "string",
+          "title": "Alt",
+          "description": "Alternative text if the image cannot be shown."
+        },
+        "height": {
+          "type": "integer",
+          "title": "Height",
+          "description": "Height of the image in pixels."
+        },
+        "width": {
+          "type": "integer",
+          "title": "Width",
+          "description": "Width of the image in pixels."
+        },
+        "digest": {
+          "$ref": "https://gobl.org/draft-0/dsig/digest",
+          "title": "Digest",
+          "description": "Digest can be used to ensure the image contained at the URL\nis the same one as originally intended."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Meta contains additional information about the image."
+        }
+      },
+      "type": "object",
+      "description": "Image describes a logo or photo that represents an entity."
+    }
+  }
+}

data/data/schemas/org/inbox.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/org/inbox",
+  "$ref": "#/$defs/Inbox",
+  "$defs": {
+    "Inbox": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Universally Unique Identifier."
+        },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label for the inbox."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Type of inbox being defined if required for clarification between multiple\ninboxes."
+        },
+        "scheme": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Scheme",
+          "description": "Scheme ID of the code used to identify the inbox. This is context specific\nand usually an ISO 6523 code or CEF (Connecting Europe Facility) code."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code or ID that identifies the Inbox. Mutually exclusive with URL and Email."
+        },
+        "url": {
+          "type": "string",
+          "title": "URL",
+          "description": "URL of the inbox that includes the protocol, server, and path. May\nbe used instead of the Code to identify the inbox. Mutually exclusive with\nCode and Email."
+        },
+        "email": {
+          "type": "string",
+          "title": "Email",
+          "description": "Email address for the inbox. Mutually exclusive with Code and URL."
+        }
+      },
+      "type": "object",
+      "description": "Inbox is used to store data about a connection with a service that is responsible for automatically receiving copies of GOBL envelopes or other document formats."
+    }
+  }
+}