> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gobl.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Inbox

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](/draft-0/cbc/key)   | Type of inbox being defined if required for clarification between multiple inboxes.                                                                           |
| Scheme | `scheme` | [cbc.Code](/draft-0/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](/draft-0/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                                                       |
| -------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| <small>Inbox</small> | <ul class="gobl-test"><li>One of code, url, email required</li></ul> | `GOBL-ORG-INBOX-01`<br />Inbox requires a code, url, or email                   |
| <small>Inbox</small> | <ul class="gobl-test"><li>Url exclusive</li></ul>                    | `GOBL-ORG-INBOX-02`<br />Inbox url must be blank when code or email is provided |
| <small>Inbox</small> | <ul class="gobl-test"><li>Email exclusive</li></ul>                  | `GOBL-ORG-INBOX-03`<br />Inbox email must be blank when code or url is provided |
| `url`                | <ul class="gobl-test"><li>Url</li></ul>                              | `GOBL-ORG-INBOX-04`<br />Inbox url must be valid                                |
| `email`              | <ul class="gobl-test"><li>Email-format</li></ul>                     | `GOBL-ORG-INBOX-05`<br />Inbox email must be valid                              |