DocumentView

Comprehensive view of a document with all its metadata and references

identifierstringrequired

Unique identifier of the document

Example: doc-123e4567-e89b-12d3-a456-426614174000

namestringrequired

Name of the document

Example: Invoice-2023.pdf

fileResource objectrequired

File resource information including identifier, name, import date and content type

identifierstringrequired

Unique identifier of the file resource

Example: file-123e4567-e89b-12d3-a456-426614174000

namestringrequired

Name of the file

Example: Invoice-2023.pdf

importDatestringrequired

Date when the file was imported

Example: 2023-01-15T14:30:00

contentTypestring | nullnullable

Content type (MIME type) of the file

Example: application/pdf

documentClass object

oneOf

• EmbeddedDocumentClassView
• null

documentClassCodestringrequired

Code of the document class

Example: INVOICE

documentClassNames object[]required

Localized names of the document class in different languages

Array [

namestringrequired

The name in the specified language

Example: Root folder

localestringrequired

Language code (ISO 639-1)

Example: en-US

]

documentClassIdentifierstringrequired

Unique identifier of the document class

Example: class-123e4567-e89b-12d3-a456-426614174000

predictedDocumentClass object

oneOf

• PredictedDocumentClassView
• null

predictedDocumentClassCodestringrequired

Code of the predicted document class

Example: INVOICE

confidenceIndexdoublenullable

Confidence level of the prediction (0-1)

Example: 0.85

predictedDocumentClassIdentifierstringrequired

Unique identifier of the predicted document class

Example: class-123e4567-e89b-12d3-a456-426614174000

predictedDocumentClassNames object[]required

Localized names of the predicted document class in different languages

Array [

namestringrequired

The name in the specified language

Example: Root folder

localestringrequired

Language code (ISO 639-1)

Example: en-US

]

predictedFolder object

oneOf

• PredictedFolderView
• null

identifierstringrequired

Unique identifier of the predicted folder

Example: folder-123e4567-e89b-12d3-a456-426614174000

names object[]required

Localized names of the predicted folder in different languages

Array [

namestringrequired

The name in the specified language

Example: Root folder

localestringrequired

Language code (ISO 639-1)

Example: en-US

]

classificationStatusstring | nullnullable

Current classification status of the document

Example: MANUAL

manuallyValidatedFolder object

oneOf

• DocumentFolderView
• null

identifierstringrequired

Unique identifier of the folder

Example: folder-123e4567-e89b-12d3-a456-426614174000

names object[]required

Localized names of the folder in different languages

Array [

namestringrequired

The name in the specified language

Example: Root folder

localestringrequired

Language code (ISO 639-1)

Example: en-US

]

documentationTags object[]required

Tags associated with the document in its documentation

Array [

idint32required

Tag ID

Example: 1

documentationIdentifierstringrequired

Documentation identifier associated with the tag

Example: doc-789

namestringrequired

Name of the tag

Example: Important

colorstring | nullnullable

Optional color for the tag (HEX code)

Example: #FF5733

]

properties object | null

Custom properties associated with the document

property name*anynullable

Custom properties associated with the document

suggestedMetadata object | null

Metadata suggested by AI or other automated processes

property name*string

metadata object | null

Validated metadata associated with the document

property name*string

documentReferences object[]required

References to other entities like assets or folders

Array [

referencedEntityTypestring | nullnullable

Type of the referenced entity

Example: ASSET

entityIdentifierstring | nullnullable

Identifier of the referenced entity

Example: asset-123e4567-e89b-12d3-a456-426614174000

documentationIdentifierstring | nullnullable

Identifier of the documentation

Example: doc-123e4567-e89b-12d3-a456-426614174000

folder object

oneOf

• DocumentFolderView
• null

identifierstringrequired

Unique identifier of the folder

Example: folder-123e4567-e89b-12d3-a456-426614174000

names object[]required

Localized names of the folder in different languages

Array [

namestringrequired

The name in the specified language

Example: Root folder

localestringrequired

Language code (ISO 639-1)

Example: en-US

]

documentLocationView object

oneOf

• DocumentLocationView
• null

documentationIdentifierstring | nullnullable

Identifier of the documentation

Example: doc-123e4567-e89b-12d3-a456-426614174000

path object[]required

Path to the document in the folder structure

Array [

identifierstring | nullnullable

Identifier of the path node

Example: folder-123e4567-e89b-12d3-a456-426614174000

names object | null

Localized names of the path node mapped by language code

property name*string

]

templateFolder object

oneOf

• DocumentTemplateFolderView
• null

identifierstringrequired

Unique identifier of the template folder

Example: template-folder-123e4567-e89b-12d3-a456-426614174000

names object[]

Localized names of the template folder in different languages

Array [

namestringrequired

The name in the specified language

Example: Root folder

localestringrequired

Language code (ISO 639-1)

Example: en-US

]

]

urlAccessstring | nullnullable

URL to access the document content

Example: https://example.com/api/documents/doc-123/content

creationDatedate-timenullable

Date and time when the document was created

Example: 2023-01-15T14:30:00

updateDatedate-timenullable

Date and time when the document was last updated

Example: 2023-02-20T09:45:00

hashstring | nullnullable

Hash value of the document content for integrity verification

Example: a1b2c3d4e5f6...

linkedAssets object[]required

Linked assets associated with this document

Array [

uidstringrequired

Unique identifier of the linked asset

Example: asset-123e4567-e89b-12d3-a456-426614174000

namestringrequired

Display name of the linked asset

Example: RU-001 - Apartment 42B

]

tenants object[]required

Tenants associated with this document

Array [

uidstringrequired

Unique identifier of the tenant

Example: tenant-123

namestringrequired

Name of the tenant

Example: John Doe

]

docsUsedToClassify object[]required

Documents used for classification

Array [

fileResourceUidstringrequired

Unique identifier of the file resource

Example: 4ga1328c-f97b-59f3-91c6-cg623beg4233

documentUidstringrequired

Unique identifier of the document

Example: 3fa1968c-f86a-48e2-80b5-bf512adf3122

cosineSimilaritystringrequired

Similarity score between this document and the classified document

Example: 0.99997663

namestringrequired

Name of the document used for classification

Example: dpe.pdf

]

uploadedBystring | nullnullable

Identifier of the user who uploaded the document

isDuplicatedboolean | nullnullable

isFiledboolean

isFiledByAIbooleanrequired

DocumentView

{
  "identifier": "doc-123e4567-e89b-12d3-a456-426614174000",
  "name": "Invoice-2023.pdf",
  "fileResource": {
    "identifier": "file-123e4567-e89b-12d3-a456-426614174000",
    "name": "Invoice-2023.pdf",
    "importDate": "2023-01-15T14:30:00",
    "contentType": "application/pdf"
  },
  "documentClass": {
    "documentClassCode": "INVOICE",
    "documentClassNames": [
      {
        "name": "Root folder",
        "locale": "en-US"
      }
    ],
    "documentClassIdentifier": "class-123e4567-e89b-12d3-a456-426614174000"
  },
  "predictedDocumentClass": {
    "predictedDocumentClassCode": "INVOICE",
    "confidenceIndex": 0.85,
    "predictedDocumentClassIdentifier": "class-123e4567-e89b-12d3-a456-426614174000",
    "predictedDocumentClassNames": [
      {
        "name": "Root folder",
        "locale": "en-US"
      }
    ]
  },
  "predictedFolder": {
    "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
    "names": [
      {
        "name": "Root folder",
        "locale": "en-US"
      }
    ]
  },
  "classificationStatus": "MANUAL",
  "manuallyValidatedFolder": {
    "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
    "names": [
      {
        "name": "Root folder",
        "locale": "en-US"
      }
    ]
  },
  "documentationTags": [
    {
      "id": 1,
      "documentationIdentifier": "doc-789",
      "name": "Important",
      "color": "#FF5733"
    }
  ],
  "properties": "Unknown Type: object,null",
  "suggestedMetadata": "Unknown Type: object,null",
  "metadata": "Unknown Type: object,null",
  "documentReferences": [
    {
      "referencedEntityType": "ASSET",
      "entityIdentifier": "asset-123e4567-e89b-12d3-a456-426614174000",
      "documentationIdentifier": "doc-123e4567-e89b-12d3-a456-426614174000",
      "folder": {
        "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
        "names": [
          {
            "name": "Root folder",
            "locale": "en-US"
          }
        ]
      },
      "documentLocationView": {
        "documentationIdentifier": "doc-123e4567-e89b-12d3-a456-426614174000",
        "path": [
          {
            "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
            "names": {
              "en": "Invoices",
              "fr": "Factures"
            }
          }
        ]
      },
      "templateFolder": {
        "identifier": "template-folder-123e4567-e89b-12d3-a456-426614174000",
        "names": "Unknown Type: array,null"
      }
    }
  ],
  "urlAccess": "https://example.com/api/documents/doc-123/content",
  "creationDate": "2023-01-15T14:30:00",
  "updateDate": "2023-02-20T09:45:00",
  "hash": "a1b2c3d4e5f6...",
  "linkedAssets": [
    {
      "uid": "asset-123e4567-e89b-12d3-a456-426614174000",
      "name": "RU-001 - Apartment 42B"
    }
  ],
  "tenants": [
    {
      "uid": "tenant-123",
      "name": "John Doe"
    }
  ],
  "docsUsedToClassify": [
    {
      "fileResourceUid": "4ga1328c-f97b-59f3-91c6-cg623beg4233",
      "documentUid": "3fa1968c-f86a-48e2-80b5-bf512adf3122",
      "cosineSimilarity": "0.99997663",
      "name": "dpe.pdf"
    }
  ],
  "uploadedBy": "string",
  "isDuplicated": true,
  "isFiled": true,
  "isFiledByAI": true
}