Inbox - GOBL

Inbox is used to store data about a connection with a service that is responsible for automatically receiving copies of GOBL envelopes or other document formats.

Schema ID

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

Properties

Title	Property	Type	Description
UUID	`uuid`	string	Universally Unique Identifier.
Label	`label`	string	Label for the inbox.
Key	`key`	cbc.Key	Type of inbox being defined if required for clarification between multiple inboxes.
Scheme	`scheme`	cbc.Code	Scheme ID of the code used to identify the inbox. This is context specific and usually an ISO 6523 code or CEF (Connecting Europe Facility) code.
Code	`code`	cbc.Code	Code or ID that identifies the Inbox. Mutually exclusive with URL and Email.
URL	`url`	string	URL of the inbox that includes the protocol, server, and path. May be used instead of the Code to identify the inbox. Mutually exclusive with Code and Email.
Email	`email`	string	Email address for the inbox. Mutually exclusive with Code and URL.

Validation Rules

Field	Test	Validation Code / Message
Inbox	One of code, url, email required	`GOBL-ORG-INBOX-01` Inbox requires a code, url, or email
Inbox	Url exclusive	`GOBL-ORG-INBOX-02` Inbox url must be blank when code or email is provided
Inbox	Email exclusive	`GOBL-ORG-INBOX-03` Inbox email must be blank when code or url is provided
`url`	Url	`GOBL-ORG-INBOX-04` Inbox url must be valid
`email`	Email-format	`GOBL-ORG-INBOX-05` Inbox email must be valid