invantive documentation
Invantive Support ForumsLog In / Sign Up

DocumentById: Minox Document by ID

read only per partition REST

  • Catalog: Minox
  • Schema: MasterDataDocument
  • Label: Document by ID

Retrieves a single document.

The data in this table is partitioned per value of the administration_code column.

Can only retrieve data.

API Source

  • Endpoint: /tenant/{tenant_id}/administration/{administration_id}/document/{document_id}
  • Operation: get /tenant/{tenant_id}/administration/{administration_id}/document/{document_id}

Parameters

Name Data Type Required Default Documentation
administration_code `` Partition to retrieve data from.
document_id `` The identity of the document.

Table Columns

The columns of the table DocumentById are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
document_administrationId varchar2 Document Administration ID filters on the platform, writable, document.administrationId The identification of the administration of the document
document_createdAt varchar2 Document Created at filters on the platform, writable, document.createdAt The creation date of the document
document_deb_cred_nr varchar2 Document Debitor/Creditor Number filters on the platform, writable, document.deb_cred_nr
document_deleted_at varchar2 Document Deleted at filters on the platform, writable, document.deleted_at The deletion date of the document
document_disabled char Document Disabled filters on the platform, writable, document.disabled Whether the document has been disabled
document_error varchar2 Document Error filters on the platform, writable, document.error The error message that could arise with a document
document_id varchar2 Document ID filters on the platform, writable, document.id The identification of the document
document_internal char Document Internal filters on the platform, writable, document.internal Whether the document is internal
document_memo varchar2 Document Memo filters on the platform, writable, document.memo The memo attached to the document
document_name varchar2 Document Name filters on the platform, writable, document.name The name of the document
document_ownerId varchar2 Document Owner ID filters on the platform, writable, document.ownerId The identification of the owner of the document
document_previewUrl varchar2 Document Preview URL filters on the platform, writable, document.previewUrl False if the document is not a PDF, otherwise the previewUrl to access the pdf
document_process varchar2 Document Process filters on the platform, writable, document.process The current state of the process of the document
document_received varchar2 Document Received filters on the platform, writable, document.received The received date of the document
document_source varchar2 Document Source filters on the platform, writable, document.source The source of the document
document_source_meta varchar2 Document Source Meta writable The source metadata of the document The JSON text of the nested object.
document_status varchar2 Document Status filters on the platform, writable, document.status The current status of the document
document_subtype varchar2 Document Subtype filters on the platform, writable, document.subtype The subtype of the document
document_type varchar2 Document Type filters on the platform, writable, document.type The type of the document
document_updatedAt varchar2 Document Updated at filters on the platform, writable, document.updatedAt The update date of the document

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

Changes of This Table, 26.0 to 27.0

  • - administration_code
  • - administration_name

All changes of the driver, 26.0 to 27.0