Skip to main content

EmbeddedDocumentClassView

Information about the validated document class

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
    metadataTypes object[]required

    Metadata types associated with the document class

  • Array [
    • identifierstringrequired
    codestringrequired
    names object[]required
  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • formatstringrequired
    unitstring | nullnullable
    descriptionstring | nullnullable
  • ]
    • EmbeddedDocumentClassView
    {
      "documentClassCode": "INVOICE",
      "documentClassNames": [
        {
          "name": "Root folder",
          "locale": "en-US"
        }
      ],
      "documentClassIdentifier": "class-123e4567-e89b-12d3-a456-426614174000",
      "metadataTypes": [
        {
          "identifier": "string",
          "code": "string",
          "names": [
            {
              "name": "Root folder",
              "locale": "en-US"
            }
          ],
          "format": "string",
          "unit": "string",
          "description": "string"
        }
      ]
    }