DocumentById: Minox Document per ID |
Retrieves a single document.
Catalogus: Minox
Schema: MasterDataDocument
Label: Document per ID
De gegevens in deze tabel zijn gepartitioneerd per waarde van de kolom administration_code.
Dit is een alleen-lezen tabelfunctie. De Minox API biedt mogelijk geen ondersteuning voor het wijzigen van de data of het Invantive SQL-stuurprogramma voor Minox ondersteunt dit niet. In het laatste geval gebruikt u de tabel NativePlatformScalarRequests om gegevens te uploaden naar de Minox-API.
Parameters van de tabelfunctie
De volgende parameters kunnen worden gebruikt om het gedrag van de tabelfunctie DocumentById in te stellen. Voor verplichte parameters moet altijd een waarde worden opgegeven, maar optionele parameters hoeven in het algemeen geen waarde te hebben en de uitvoering zal standaard een vooraf bepaald gedrag vertonen. Waarden kunnen worden gespecificeerd op basis van positie en naam. In beide gevallen worden alle niet-gespecificeerde parameters geëvalueerd aan de hand van hun standaardwaarden.
Waardespecificatie op positie gebeurt door alle waarden van de eerste tot de laatste benodigde waarde op te sommen. Bijvoorbeeld: een `select * uit tabel(waarde1, waarde2, waarde3)` op een tabel met vier parameters zal de standaardwaarde voor de vierde parameter gebruiken en de opgegeven waarden voor de eerste drie.
Waardespecificatie op naam gebeurt door alle waarden die een waarde vereisen op te sommen. Bijvoorbeeld met `selecteer * uit tabel(naam1 => waarde1, naam3 => waarde3)` op dezelfde tabel zullen de standaardwaarden voor de tweede en vierde parameter worden gebruikt en de opgegeven waarden voor de eerste en derde.
Naam |
Datatype |
Verplicht |
Standaardwaarde |
Documentatie |
---|---|---|---|---|
administration_code |
string |
☐ |
|
Partition to retrieve data from. |
document_id |
string |
☑ |
|
The identity of the document. |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie DocumentById worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
administration_code |
string(30) |
Administratiecode |
☑ |
Partition code, segmenting the data. |
administration_name |
string(240) |
Administratie Naam |
☑ |
Name of the partition. |
document_administrationId |
string |
Document Administratie ID |
☐ |
The identification of the administration of the document |
document_createdAt |
string |
Document Gemaakt op |
☐ |
The creation date of the document |
document_deb_cred_nr |
string |
Document Debiteur-/Crediteurnummer |
☐ |
|
document_deleted_at |
string |
Document Verwijderd op |
☐ |
The deletion date of the document |
document_disabled |
boolean |
Document Uitgeschakeld |
☐ |
Whether the document has been disabled |
document_error |
string |
Documentfout |
☐ |
The error message that could arise with a document |
document_id |
string |
Document ID |
☐ |
The identification of the document |
document_internal |
boolean |
Document Intern |
☐ |
Whether the document is internal |
document_memo |
string |
Document Memo |
☐ |
The memo attached to the document |
document_name |
string |
Documentnaam |
☐ |
The name of the document |
document_ownerId |
string |
Documenteigenaar ID |
☐ |
The identification of the owner of the document |
document_previewUrl |
string |
Documentvoorbeeld URL |
☐ |
False if the document is not a PDF, otherwise the previewUrlto access the pdf |
document_process |
string |
Document Verwerken |
☐ |
The current state of the process of the document |
document_received |
string |
Document Ontvangen |
☐ |
The received date of the document |
document_source_meta |
string |
Documentbron Meta |
☐ |
The source metadata of the document |
document_source |
string |
Documentbron |
☐ |
The source of the document |
document_status |
string |
Documentstatus |
☐ |
The current status of the document |
document_subtype |
string |
Documentsubtype |
☐ |
The subtype of the document |
document_type |
string |
Documentsoort |
☐ |
The type of the document |
document_updatedAt |
string |
Document Bijgewerkt op |
☐ |
The update date of the document |
22-12-2022 21:29 Versie 22.1.101-BETA+3681