API Reference
Log In
API Reference

Record Subtypes

A Record Subtype is the tag attached to a Folder (record) within a Hanger (recordType). For example, within a "Tax Documents" Hanger, you may have Record Subtypes such as:

  • Income Tax
  • Property Tax
  • Sales Tax

These tags can be attached to Folders to help organize your documents.


[
  {
    "id": "{recordSubtypeId}",
    "name": "salesTax",
    "logo": "",
    "displayValue": [
      {
        "locale": "en-CA",
        "value": "Sales Tax",
        "description": ""
      }
    ],
    "orderId": 0,
    "recordsSections": {
      "sectionDescription": true,
      "sectionFiles": true,
      "sectionLinkedRecords": true,
      "sectionCollaborators": true,
      "sectionSpecificFields": true,
      "sectionReminders": true,
      "sectionSignatures": true
    }
  }
]

Record Subtype entity

id string required
Unique Record Subtype identifier.

name string required
The Record Subtype name.

logo string required
URL of the logo of the Record Subtype.

displayValue array of Display Value entities required
List of values to display, depending on the language.

orderId number
Number of the position of this Record Subtype when the Record Subtypes are sorted in a list.

recordsSections entity
Series of flags that allow the front-end application to show or hide sections within a folder (record) creation/edition.


Display Value (displayValue) entity

locale enum required
Locale.
Possible values: en-CA, fr-CA, en-US, es-US.

value string required
Value of display.

description string
Description.


Records Sections entity

sectionDescription boolean
"Storage" and "description".

sectionFiles boolean
File history, upload, cloud sync.

sectionLinkedRecords boolean
Related and Linked Folders (records).

sectionCollaborators boolean
Collaborators.

sectionSpecificFields boolean
Additional Info fields.

sectionReminders boolean
Reminders section.

sectionSignatures boolean
Signatures section.