Applications.Rental.TransactionTemplates Entity

Specifies additional options for document routes, generating Rental Transactions. Entity: Rent_Transaction_Templates

Default Visualization

Default Display Text Format:
{Route.ProcedureName}
Default Search Members:
Route.ProcedureName
Name Data Member:
Route.ProcedureName
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 Parent:
Systems.Documents.Routes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
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.
TransactionType	TransactionType	Transaction type for the rent transaction that is to be created. `Required`

References

Name	Type	Description
Route	Routes	The route for which the transaction template is defined. `Required` `Filter(multi eq)` `Owner`

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

Id

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

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

TransactionType

Transaction type for the rent transaction that is to be created. Required

Type: TransactionType
Category: System
Allowed values for the TransactionType(Applications.Rental.Transactions.md#transactiontype) data attribute
Allowed Values (Applications.Rental.TransactionsRepository.TransactionType Enum Members)

Value	Description
Deliver	Deliver value. Stored as 'D'. Database Value: 'D' Model Value: 0 Domain API Value: 'Deliver'
Receive	Receive value. Stored as 'R'. Database Value: 'R' Model Value: 1 Domain API Value: 'Receive'
WriteOffNotReturned	WriteOffNotReturned value. Stored as 'W'. Database Value: 'W' Model Value: 2 Domain API Value: 'WriteOffNotReturned'
StatusReport	StatusReport value. Stored as 'S'. Database Value: 'S' Model Value: 3 Domain API Value: 'StatusReport'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

Route

The route for which the transaction template is defined. Required Filter(multi eq) Owner

Type: Routes
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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