Skip to main content
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.

​
Schema ID

https://gobl.org/draft-0/org/attachment

​
Properties

TitlePropertyTypeDescription
UUIDuuidstringUniversally Unique Identifier.
Keykeycbc.KeyKey used to identify the attachment inside the document.
Codecodecbc.CodeCode used to identify the payload of the attachment.
NamenamestringFilename of the attachment, will override name retrieved from URL.
DescriptiondescriptionstringDetails of why the attachment is being included and details on what it contains.
URLurlstringURL of where to find the attachment.
Digestdigestdsig.DigestDigest is used to verify the integrity of the attachment when downloaded from the URL.
MIME TypemimestringMIME type of the attachment.

​
Validation Rules

FieldTestValidation Code / Message
url
  • Present
  • Url
GOBL-ORG-ATTACHMENT-01
Attachment URL must be valid
mime
  • One of [application/pdf, image/jpeg, image/png, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.oasis.opendocument.spreadsheet]
GOBL-ORG-ATTACHMENT-02
Attachment MIME type must be of an expected types defined in EN16931-1:2017