Link - GOBL

Link defines a link between this document and another resource.

Schema ID

https://gobl.org/draft-0/head/link

Properties

Title	Property	Type	Description
UUID	`uuid`	string	Universally Unique Identifier.
Category	`category`	cbc.Key	Category helps classify the link according to a fixed list. This is optional but highly recommended as it helps receivers better understand the purpose of the link and potentially how it should be presented.
	`key`	cbc.Key	Key is a unique identifier for the link within the header and category if provided.
Code	`code`	cbc.Code	Code used to identify the contents of the link.
Title	`title`	string	Title of the resource to use when presenting to users.
Description	`description`	string	Description of the resource to use when presenting to users.
MIME Type	`mime`	string	Expected MIME type of the link’s content when the content is a file. Can only be one of the allowed types defined by EN 16931-1:2017 plus XML itself.
Digest	`digest`	dsig.Digest	Digest is used to verify the integrity of the destination document when downloaded from the URL.
URL	`url`	string	URL of the resource.
Metadata	`meta`	cbc.Meta	Meta contains additional metadata about the link.

Category Values

Value	Description
`format`	Alternative formats of the same document, such as PDF, HTML, or XML.
`portal`	Websites that provide access to alternative versions of this document or request modifications. May also allow access to other or previous business documents.
`request`	Documents related to requests submitted to other systems.
`response`	Response documents sent from third party systems often in reply to requests.
`agreement`	Contracts or agreements related to this document.
`verification`	Evidence or verification documents that can be used to validate the authenticity of this document.
`attachment`	General attachments for related information such as spread sheets, letters, presentations, specifications, etc.

Validation Rules

Field	Test	Validation Code / Message
Link	No digest without MIME	`GOBL-HEAD-LINK-06` Link digest must be nil when MIME type is not provided
`key`	Present	`GOBL-HEAD-LINK-01` Link key is required
`category`	Valid or empty	`GOBL-HEAD-LINK-02` Link category is not valid
`url`	Present	`GOBL-HEAD-LINK-03` Link URL is required
`url`	Url	`GOBL-HEAD-LINK-04` Link URL must be a valid URL
`mime`	Valid or empty MIME	`GOBL-HEAD-LINK-05` Link MIME type is not valid

⌘I