API Docs / Schemas / ModuleDto

ModuleDto

DTO for module data.

Properties

Name Type Description
codestring

URL-friendly identifier for the module

URL-friendly identifier for the module

namestring

Display name of the module

Display name of the module

descriptionstring

Detailed description of the module and its features

Detailed description of the module and its features

permissibleEntityCountinteger

Number of permissible entities in this module

Number of permissible entities in this module

packageCountinteger

Number of packages that contain this module

Number of packages that contain this module

permissibleEntitiesarray of enum

Permissible entities that this module provides access to

Tasks Users Clients Contacts ClientContacts Reports Settings ApiKeys Roles BillableServices ClientBillableServices RecurringTasks Workflows ThirdPartyConnections ContentBlocks PracticeDetails DesignThemes Templates ClientDocuments Engagements

Permissible entities that this module provides access to

Tasks Users Clients Contacts ClientContacts Reports Settings ApiKeys Roles BillableServices ClientBillableServices RecurringTasks Workflows ThirdPartyConnections ContentBlocks PracticeDetails DesignThemes Templates ClientDocuments Engagements

packagesarray of CodeAndNameDto

Packages that contain this module

Packages that contain this module

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "permissibleEntityCount": 0,
  "packageCount": 0
}