Crm.Marketing.CompanySizeClasses Entity
Namespace: Crm.Marketing
Categorization of company sizes for marketing purposes. Size classes might depend on number of employees, annual revenue and/or other factors (expresses as user defined attributes). Entity: Crm_Company_Size_Classes (Introduced in version 21.1.3.59)
Default Visualization
Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault
Track Changes
Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
Code | string (32) | The unique code of the CompanySizeClass. Required Filter(eq;like) ORD |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
FromEmployees | int32 nullable | Minimal number of employees for this size class. null if this is not relevant to this size class. Filter(eq) |
FromRevenue | decimal (15, 0) nullable | Minimal revenue for this size class. Currency is Revenue Currency. null if this is not relevant to this size class. Filter(eq) |
Id | guid | |
IsActive | boolean | Indicates whether the current Company size class is active. Required Default(true) Filter(eq) Introduced in version 25.1.0.18 |
Name | MultilanguageString (254) | Company size class name (multi-language). Required Filter(eq;like) |
Notes | string (max) nullable | Notes for this CompanySizeClass. |
ObjectVersion | int32 | The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking. |
ToEmployees | int32 nullable | Maximum number of employees for this size class. null if this is not relevant to this size class. Filter(eq) |
ToRevenue | decimal (15, 0) nullable | Maximal revenue for this size class. Currency is Revenue Currency. null if this is not relevant to this size class. Filter(eq) |
References
Name | Type | Description |
---|---|---|
RevenueCurrency | Currencies (nullable) | The currency in which the revenues are states. null if no revenues are specified. Filter(multi eq) |
Attribute Details
Code
The unique code of the CompanySizeClass. Required
Filter(eq;like)
ORD
Type: string (32)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 32
Show in UI: ShownByDefault
DisplayText
Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
FromEmployees
Minimal number of employees for this size class. null if this is not relevant to this size class. Filter(eq)
Type: int32 nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault
FromRevenue
Minimal revenue for this size class. Currency is Revenue Currency. null if this is not relevant to this size class. Filter(eq)
Type: decimal (15, 0) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
IsActive
Indicates whether the current Company size class is active. Required
Default(true)
Filter(eq)
Introduced in version 25.1.0.18
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault
Name
Company size class name (multi-language). Required
Filter(eq;like)
Type: MultilanguageString (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault
Notes
Notes for this CompanySizeClass.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
ObjectVersion
The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
ToEmployees
Maximum number of employees for this size class. null if this is not relevant to this size class. Filter(eq)
Type: int32 nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault
ToRevenue
Maximal revenue for this size class. Currency is Revenue Currency. null if this is not relevant to this size class. Filter(eq)
Type: decimal (15, 0) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault
Reference Details
RevenueCurrency
The currency in which the revenues are states. null if no revenues are specified. Filter(multi eq)
Type: Currencies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
API Methods
Methods that can be invoked in public APIs.
GetAllowedCustomPropertyValues
Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET
Parameters
customPropertyCode
The code of the custom property
Type: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
CreateNotification
Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The notification subject.
Type: string
CreateCopy
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
Business Rules
None
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Marketing_CompanySizeClasses?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Marketing_CompanySizeClasses?$top=10