EntityWithDetails

    • createdAt
      Type: stringFormat: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • entityTypeId
      Type: integer
      required

      Entity type ID (1-5)

    • hierarchyLevel
      Type: integer
      required

      Depth in tree (0=root)

    • id
      Type: stringFormat: uuid
      required

      Entity UUID

    • isPartner
      Type: boolean
      required

      Whether entity can have child entities

    • name
      Type: string
      required

      Entity name

    • status
      Type: stringenum
      required
      values
      • active
      • inactive
      • suspended
      • pending
      • trial
    • updatedAt
      Type: stringFormat: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • childCount
      Type: integer

      Number of direct children

    • createdBy
      Type: integer nullable

      Integer numbers.

    • deletedAt
      Type: stringFormat: date-time nullable

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • descendantCount
      Type: integer

      Total descendants count

    • entityTypeCode
      Type: string nullable

      Entity type code

    • entityTypeName
      Type: string nullable

      Entity type display name

    • faviconUrl
      Type: string nullable

      Entity favicon URL

    • hierarchyPath
      Type: string nullable

      Full path from root

    • legalName
      Type: string nullable

      Official legal entity name

    • logoUrl
      Type: string nullable

      Entity logo URL

    • notificationFromEmail
      Type: stringFormat: email nullable
    • parentEntityId
      Type: stringFormat: uuid nullable

      Parent entity UUID

    • parentName
      Type: string nullable

      Parent entity name

    • portalUrl
      Type: string nullable

      Custom portal URL

    • primaryContactEmail
      Type: stringFormat: email nullable
    • primaryContactMobile
      Type: string nullable
    • primaryContactName
      Type: string nullable

      Primary contact full name

    • primaryContactPhone
      Type: string nullable
    • primaryContactTitle
      Type: string nullable

      Primary contact job title

    • referralId
      Type: stringFormat: uuid nullable

      Referring entity UUID

    • supportEmail
      Type: stringFormat: email nullable
    • updatedBy
      Type: integer nullable

      Integer numbers.

    • websiteUrl
      Type: string nullable

      Entity website URL