# DocumentById: Minox Document by ID Retrieves a single document. - Catalog: `Minox` - Schema: `MasterDataDocument` - Label: Document by ID The data in this table is partitioned per value of the `administration_code` column. This is a read-only table function. The Minox API may not support changing the data or the Invantive UniversalSQL driver for Minox does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Minox API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `DocumentById`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `administration_code` | `` | ☐ | | Partition to retrieve data from. | | `document_id` | `` | ☑ | | The identity of the document. | ## Columns of Table Function The columns of the table function `DocumentById` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `document_administrationId` | `varchar2` | Document Administration ID | ☐ | The identification of the administration of the document | | `document_createdAt` | `varchar2` | Document Created at | ☐ | The creation date of the document | | `document_deb_cred_nr` | `varchar2` | Document Debitor/Creditor Number | ☐ | | | `document_deleted_at` | `varchar2` | Document Deleted at | ☐ | The deletion date of the document | | `document_disabled` | `char` | Document Disabled | ☐ | Whether the document has been disabled | | `document_error` | `varchar2` | Document Error | ☐ | The error message that could arise with a document | | `document_id` | `varchar2` | Document ID | ☐ | The identification of the document | | `document_internal` | `char` | Document Internal | ☐ | Whether the document is internal | | `document_memo` | `varchar2` | Document Memo | ☐ | The memo attached to the document | | `document_name` | `varchar2` | Document Name | ☐ | The name of the document | | `document_ownerId` | `varchar2` | Document Owner ID | ☐ | The identification of the owner of the document | | `document_previewUrl` | `varchar2` | Document Preview URL | ☐ | False if the document is not a PDF, otherwise the previewUrl to access the pdf | | `document_process` | `varchar2` | Document Process | ☐ | The current state of the process of the document | | `document_received` | `varchar2` | Document Received | ☐ | The received date of the document | | `document_source_meta` | `varchar2` | Document Source Meta | ☐ | The source metadata of the document The JSON text of the nested object. | | `document_source` | `varchar2` | Document Source | ☐ | The source of the document | | `document_status` | `varchar2` | Document Status | ☐ | The current status of the document | | `document_subtype` | `varchar2` | Document Subtype | ☐ | The subtype of the document | | `document_type` | `varchar2` | Document Type | ☐ | The type of the document | | `document_updatedAt` | `varchar2` | Document Updated at | ☐ | The update date of the document |