Module

The Module object represents a module in the Marketplace platform. This object contains the following properties:

Field
Type
Description

id

string

Primary module identifier.

Example: MOD-1234

name

string

Name of the module.

Example: Invoices

description

string

Description of the module.

Example: Invoices module

accountTypes

string

Defines the presence of the module for each account type.

Example: Vendor

isEnabledByDefault

boolean

Defines whether the module is enabled by default.

Example: true

isConfigurable

boolean

Defines whether the module’s access can be changed.

Example: true

Example

{
  "id": "MOD-1234",
  "name": "Invoices",
  "description": "Invoices module",
  "accountTypes": ["vendor", "client", "operations"],
  "isEnabledByDefault": true,
  "isConfigurable": false
}

Last updated

Was this helpful?