Org
Attachment
Org
Attachment
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
| Title | Property | Type | Req. | Description |
|---|---|---|---|---|
| UUID | uuid | string | Universally Unique Identifier. | |
| Key | key | cbc.Key | Key used to identify the attachment inside the document. | |
| Code | code | cbc.Code | Code used to identify the payload of the attachment. | |
| Name | name | string | true | Filename of the attachment. |
| Description | description | string | Details of why the attachment is being included and details on what it contains. | |
| URL | url | string | URL of where to find the attachment. Prefer using this field over the Data field. | |
| Digest | digest | dsig.Digest | Digest is used to verify the integrity of the attachment when downloaded from the URL. | |
| MIME Type | mime | string | MIME type of the attachment. | |
| Data | data | string | Data is the base64 encoded data of the attachment directly embedded inside the GOBL document. This should only be used when the URL cannot be used as it can dramatically increase the size of the JSON document, thus effecting usability and performance. |