Crm.Subscriptions.Subscriptions Entity

Namespace: Crm.Subscriptions

Agreements with customers for periodic delivery of services and billing. Entity: Sm_Subscriptions (Introduced in version 24.1.2.6)

Default Visualization

Default Display Text Format:
{Customer.Party.PartyName:T} - {BillingCycle.Name:T}
Default Search Members:
__
Category: Definitions
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

• Crm.Subscriptions.Subscriptions
  • Crm.Subscriptions.SubscriptionLines

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	date	The starting date of the subscription. Required Default(NowUtc) Filter(eq;ge;le)
Id	guid
Notes	MultilanguageString (max) nullable	Notes for this Subscription. Filter(like)
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.
ToDate	date nullable	The final date of the subscription if it is time fenced. null means that the subscription is currently open-ended. Filter(eq;ge;le)

References

Name	Type	Description
BillingCycle	BillingCycles (nullable)	The cycle which to use for billing purposes. null means that there would be no automatic billing for this subscription. Filter(multi eq)
Customer	Customers	The customer of the subscription. Required Filter(multi eq)
EnterpriseCompany	EnterpriseCompanies	The enterprise company, which issues the subscription. Required Filter(multi eq)

Child Collections

Name	Type	Description
Lines	SubscriptionLines	List of SubscriptionLine(Crm.Subscriptions.SubscriptionLines.md) child objects, based on the Crm.Subscriptions.SubscriptionLine.Subscription(Crm.Subscriptions.SubscriptionLines.md#subscription) back reference

Attribute Details

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

FromDate

The starting date of the subscription. Required Default(NowUtc) Filter(eq;ge;le)

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Notes

Notes for this Subscription. Filter(like)

Type: MultilanguageString (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
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

ToDate

The final date of the subscription if it is time fenced. null means that the subscription is currently open-ended. Filter(eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

BillingCycle

The cycle which to use for billing purposes. null means that there would be no automatic billing for this subscription. Filter(multi eq)

Type: BillingCycles (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Customer

The customer of the subscription. Required Filter(multi eq)

Type: Customers
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EnterpriseCompany

The enterprise company, which issues the subscription. Required Filter(multi eq)

Type: EnterpriseCompanies
Indexed: True
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: string

• search
  The search text - searches by value or description. Can contain wildcard character %.
  Type: string
  Optional: True
  Default Value: null

• exactMatch
  If true the search text should be equal to the property value
  Type: boolean
  Optional: True
  Default Value: False

• orderByDescription
  If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
  Type: boolean
  Optional: True
  Default Value: False

• top
  The top clause - default is 10
  Type: int32
  Optional: True
  Default Value: 10

• skip
  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: Users

• notificationClass
  The notification class.
  Type: string

• subject
  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_Subscriptions_Subscriptions?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Subscriptions_Subscriptions?$top=10