Merge pull request #328 from invopop/org-labels

Adding and refining labels on key org structures

CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to GOBL will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). See also the [GOBL versions](https://docs.gobl.org/overview/versions) documentation site for more details.
 
+## [v0.110.2] - 2024-07-23
+
+### Added
+
+- `org.Person`: now has `label` field.
+
+### Changed
+
+- `org`: Refining availablility of `label` field.
+
 ## [v0.110.0] - 2024-07-23
 
 Multiple version upgrade after merging the [gobl.cli](https://github.com/invopop/gobl.cli) project directly here instead.

data/schemas/org/address.json

@@ -14,7 +14,10 @@
         "label": {
           "type": "string",
           "title": "Label",
-          "description": "Useful identifier, such as home, work, etc."
+          "description": "Useful identifier, such as home, work, etc.",
+          "examples": [
+            "Office"
+          ]
         },
         "po_box": {
           "type": "string",

data/schemas/org/party.json

@@ -11,6 +11,14 @@
           "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",
@@ -21,14 +29,6 @@
           "title": "Alias",
           "description": "Alternate short name."
         },
-        "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"
-          ]
-        },
         "tax_id": {
           "$ref": "https://gobl.org/draft-0/tax/identity",
           "title": "Tax Identity",

data/schemas/org/person.json

@@ -11,6 +11,14 @@
           "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"
+          ]
+        },
         "name": {
           "$ref": "https://gobl.org/draft-0/org/name",
           "title": "Name",

data/schemas/org/registration.json

@@ -11,6 +11,13 @@
           "title": "UUID",
           "description": "Universally Unique Identifier."
         },
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "examples": [
+            "Registration"
+          ]
+        },
         "capital": {
           "$ref": "https://gobl.org/draft-0/num/amount",
           "title": "Capital"

org/address.go

@@ -16,7 +16,7 @@ import (
 type Address struct {
 	uuid.Identify
 	// Useful identifier, such as home, work, etc.
-	Label string `json:"label,omitempty" jsonschema:"title=Label"`
+	Label string `json:"label,omitempty" jsonschema:"title=Label,example=Office"`
 	// Box number or code for the post office box located at the address.
 	PostOfficeBox string `json:"po_box,omitempty" jsonschema:"title=Post Office Box"`
 	// House or building number in the street.

org/party.go

@@ -13,13 +13,13 @@ import (
 // Party represents a person or business entity.
 type Party struct {
 	uuid.Identify
+	// Label can be used to provide a custom label for the party in a given
+	// context in a single language, for example "Supplier", "Host", or similar.
+	Label string `json:"label,omitempty" jsonschema:"title=Label,example=Supplier"`
 	// Legal name or representation of the organization.
 	Name string `json:"name" jsonschema:"title=Name"`
 	// Alternate short name.
 	Alias string `json:"alias,omitempty" jsonschema:"title=Alias"`
-	// Label can be used to provide a custom label for the party in a given
-	// context in a single language, for example "Supplier", "Host", or similar.
-	Label string `json:"label,omitempty" jsonschema:"title=Label,example=Supplier"`
 	// 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.
 	TaxID *tax.Identity `json:"tax_id,omitempty" jsonschema:"title=Tax Identity"`
 	// Set of codes used to identify the party in other systems.

org/person.go

@@ -12,6 +12,9 @@ import (
 // Person represents a human, and how to contact them electronically.
 type Person struct {
 	uuid.Identify
+	// Label can be used to identify the person in a given context in a single
+	// language, for example "Attn", "Contact", "Responsible", etc.
+	Label string `json:"label,omitempty" jsonschema:"title=Label,example=Attn"`
 	// Complete details on the name of the person
 	Name Name `json:"name" jsonschema:"title=Name"`
 	// What they do within an organization
@@ -36,6 +39,7 @@ func (p *Person) ValidateWithContext(ctx context.Context) error {
 	return tax.ValidateStructWithRegime(ctx, p,
 		validation.Field(&p.UUID),
 		validation.Field(&p.Name, validation.Required),
+		validation.Field(&p.Label),
 		validation.Field(&p.Emails),
 		validation.Field(&p.Telephones),
 		validation.Field(&p.Avatars),

org/registration.go

@@ -16,6 +16,7 @@ import (
 // If your country requires additional fields, please let us know.
 type Registration struct {
 	uuid.Identify
+	Label    string        `json:"label,omitempty" jsonschema:"title=Label,example=Registration"`
 	Capital  *num.Amount   `json:"capital,omitempty" jsonschema:"title=Capital"`
 	Currency currency.Code `json:"currency,omitempty" jsonschema:"title=Currency"`
 	Office   string        `json:"office,omitempty" jsonschema:"title=Office"`
@@ -37,6 +38,7 @@ func (r *Registration) Validate() error {
 func (r *Registration) ValidateWithContext(ctx context.Context) error {
 	return tax.ValidateStructWithRegime(ctx, r,
 		validation.Field(&r.UUID),
+		validation.Field(&r.Label),
 		validation.Field(&r.Capital),
 		validation.Field(&r.Currency),
 		validation.Field(&r.Office),

version.go

@@ -8,7 +8,7 @@ import (
 type Version string
 
 // VERSION is the current version of the GOBL library.
-const VERSION Version = "v0.110.1"
+const VERSION Version = "v0.110.2"
 
 // Semver parses and returns semver
 func (v Version) Semver() *semver.Version {