gobl 0.24.1 → 0.24.3

data/data/schemas/currency/exchange-rate.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/currency/exchange-rate",
+  "$ref": "#/$defs/ExchangeRate",
+  "$defs": {
+    "ExchangeRate": {
+      "properties": {
+        "from": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "From",
+          "description": "Currency code this will be converted from."
+        },
+        "to": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "To",
+          "description": "Currency code this exchange rate will convert into."
+        },
+        "at": {
+          "$ref": "https://gobl.org/draft-0/cal/date-time",
+          "title": "At",
+          "description": "At represents the effective date and time at which the exchange rate\nis determined by the source. The time may be zero if referring to a\nspecific day only."
+        },
+        "source": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Source",
+          "description": "Source key provides a reference to the source the exchange rate was\nobtained from. Typically this will be determined by an application\nused to update exchange rates automatically."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "How much is 1 of the \"from\" currency worth in the \"to\" currency."
+        }
+      },
+      "type": "object",
+      "required": [
+        "from",
+        "to",
+        "amount"
+      ],
+      "description": "ExchangeRate contains data on the rate to be used when converting amounts from one currency into another."
+    }
+  }
+}

data/data/schemas/dsig/digest.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/dsig/digest",
+  "$ref": "#/$defs/Digest",
+  "$defs": {
+    "Digest": {
+      "properties": {
+        "alg": {
+          "type": "string",
+          "title": "Algorithm",
+          "description": "Algorithm stores the algorithm key that was used to generate the value."
+        },
+        "val": {
+          "type": "string",
+          "title": "Value",
+          "description": "Value contains the Hexadecimal representation of the resulting hash\ngenerated by the algorithm."
+        }
+      },
+      "type": "object",
+      "required": [
+        "alg",
+        "val"
+      ],
+      "description": "Digest defines a structure to hold a digest value including the algorithm used to generate it."
+    }
+  }
+}

data/data/schemas/dsig/signature.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/dsig/signature",
+  "$ref": "#/$defs/Signature",
+  "$defs": {
+    "Signature": {
+      "type": "string",
+      "title": "Signature",
+      "description": "JSON Web Signature in compact form."
+    }
+  }
+}

data/data/schemas/envelope.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/envelope",
+  "$ref": "#/$defs/Envelope",
+  "$defs": {
+    "Envelope": {
+      "properties": {
+        "$schema": {
+          "type": "string",
+          "title": "JSON Schema ID",
+          "description": "Schema identifies the schema that should be used to understand this document"
+        },
+        "head": {
+          "$ref": "https://gobl.org/draft-0/head/header",
+          "title": "Header",
+          "description": "Details on what the contents are"
+        },
+        "doc": {
+          "$ref": "https://gobl.org/draft-0/schema/object",
+          "title": "Document",
+          "description": "The data inside the envelope"
+        },
+        "sigs": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/dsig/signature"
+          },
+          "type": "array",
+          "title": "Signatures",
+          "description": "JSON Web Signatures of the header"
+        }
+      },
+      "type": "object",
+      "required": [
+        "$schema",
+        "head",
+        "doc"
+      ],
+      "description": "Envelope wraps around a document adding headers and digital signatures."
+    }
+  }
+}

data/data/schemas/head/header.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/head/header",
+  "$ref": "#/$defs/Header",
+  "$defs": {
+    "Header": {
+      "properties": {
+        "uuid": {
+          "type": "string",
+          "format": "uuid",
+          "title": "UUID",
+          "description": "Unique UUIDv1 identifier for the envelope."
+        },
+        "dig": {
+          "$ref": "https://gobl.org/draft-0/dsig/digest",
+          "title": "Digest",
+          "description": "Digest of the canonical JSON body."
+        },
+        "stamps": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/head/stamp"
+          },
+          "type": "array",
+          "title": "Stamps",
+          "description": "Seals of approval from other organisations that can only be added to\nnon-draft envelopes."
+        },
+        "links": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/head/link"
+          },
+          "type": "array",
+          "title": "Links",
+          "description": "Links provide URLs to other resources that are related to this envelope\nand unlike stamps can be added even in the draft state."
+        },
+        "tags": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "title": "Tags",
+          "description": "Set of labels that describe but have no influence on the data."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Additional semi-structured information about this envelope."
+        },
+        "notes": {
+          "type": "string",
+          "title": "Notes",
+          "description": "Any information that may be relevant to other humans about this envelope"
+        }
+      },
+      "type": "object",
+      "required": [
+        "uuid",
+        "dig"
+      ],
+      "description": "Header defines the metadata of the body."
+    }
+  }
+}

data/data/schemas/head/link.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/head/link",
+  "$ref": "#/$defs/Link",
+  "$defs": {
+    "Link": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "description": "Key is a unique identifier for the link."
+        },
+        "title": {
+          "type": "string",
+          "title": "Title",
+          "description": "Title of the resource to use when presenting to users."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "Description of the resource to use when presenting to users."
+        },
+        "mime": {
+          "type": "string",
+          "title": "MIME Type",
+          "description": "Expected MIME type of the link's content."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "title": "URL",
+          "description": "URL of the resource."
+        }
+      },
+      "type": "object",
+      "required": [
+        "key",
+        "url"
+      ],
+      "description": "Link defines a link between this document and another resource."
+    }
+  }
+}

data/data/schemas/head/stamp.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/head/stamp",
+  "$ref": "#/$defs/Stamp",
+  "$defs": {
+    "Stamp": {
+      "properties": {
+        "prv": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Provider",
+          "description": "Identity of the agency used to create the stamp usually defined by each region."
+        },
+        "val": {
+          "type": "string",
+          "title": "Value",
+          "description": "The serialized stamp value generated for or by the external agency"
+        }
+      },
+      "type": "object",
+      "required": [
+        "prv",
+        "val"
+      ],
+      "description": "Stamp defines an official seal of approval from a third party like a governmental agency or intermediary and should thus be included in any official envelopes."
+    }
+  }
+}

data/data/schemas/i18n/string.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/i18n/string",
+  "$ref": "#/$defs/String",
+  "$defs": {
+    "String": {
+      "patternProperties": {
+        "^[a-z]{2}$": {
+          "type": "string",
+          "title": "Text in given language."
+        }
+      },
+      "type": "object",
+      "title": "Multi-language String",
+      "description": "Map of 2-Letter language codes to their translations."
+    }
+  }
+}

data/data/schemas/l10n/code.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/l10n/code",
+  "$ref": "#/$defs/Code",
+  "$defs": {
+    "Code": {
+      "type": "string",
+      "pattern": "^[A-Z0-9]+$",
+      "title": "Code",
+      "description": "Code is used for short identifies like country or state codes."
+    }
+  }
+}