Applications.Rental.Assets Entity

Contains the rentable assets. Entity: Rent_Assets

Default Visualization

Default Display Text Format:
{RentalAssetName}
Default Search Members:
RentalAssetCode; RentalAssetName
Code Data Member:
RentalAssetCode
Name Data Member:
RentalAssetName
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: RentalAssetTypeId

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

Applications.Rental.Assets
- Applications.Rental.AssetConsumables

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
IsActive	boolean	True if the asset is currently active and may be used in new documents. Deactivated assets are used only in reports. `Required` `Default(true)` `Filter(eq)`
Notes	string (max) nullable	Notes for this Asset.
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.
RentalAssetCode	string (20)	Unique rental asset code. `Required` `Filter(eq;like)` `ORD`
RentalAssetName	string (254)	The name of the rental asset. `Required` `Filter(like)`
StandardGuaranteeAmount	Amount (14, 2) nullable	Standard default amount of the guarantee that is set for this asset when leased. `Currency: StandardGuarantee<br />AmountCurrency` `Filter(multi eq)`
TimePeriodType	TimePeriodType nullable	Specifies the unit by which the periods of renting of this asset are measured. `Filter(multi eq)`

References

Name	Type	Description
AccountingAsset	Assets (nullable)	When not null identifies the corresponding accounting asset. `Filter(multi eq)`
EnterpriseCompany	EnterpriseCompanies (nullable)	When not null, specifies that the asset is specific to a given enterprise company and may be used only in documents from this enterprise company. If null, the asset can be used in all enterprise companies. `Filter(multi eq)`
ManagedAsset	ManagedAssets (nullable)	Link to a managed asset definition from the asset management module. It is used to manage, track and maintain the asset. `Filter(multi eq)` `Introduced in version 24.1.4.74`
Product	Products (nullable)	Product which is used in the store transactions for this asset. `Filter(multi eq)`
RentalAssetGroup	AssetGroups	The logical group of the rental asset. `Required` `Filter(multi eq)`
RentalAssetType	AssetTypes	The type of the asset. `Required` `Filter(multi eq)`
SalesProduct	Products (nullable)	Product which is used in the creation of Sales Orders to form the price of the service of renting this asset. `Filter(multi eq)`
SerialNumber	SerialNumbers (nullable)	Serial number which in conjunction with the product for store operations allows for more accurate identification of the asset. `Filter(multi eq)`
StandardGuarantee AmountCurrency	Currencies (nullable)	Currency of the standard guarantee amount. `Filter(multi eq)`
WorkSchedule	WorkSchedules (nullable)	Work schedule, which is used to calculate how many days this assets has been rented for (used only when the asset's lease by mode is by days). `Filter(multi eq)`

Child Collections

Name	Type	Description
Consumables	AssetConsumables	List of `AssetConsumable`(Applications.Rental.AssetConsumables.md) child objects, based on the `Applications.Rental.AssetConsumable.RentalAsset`(Applications.Rental.AssetConsumables.md#rentalasset) 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

Id

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

IsActive

True if the asset is currently active and may be used in new documents. Deactivated assets are used only in reports. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Notes

Notes for this Asset.

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

RentalAssetCode

Unique rental asset code. Required Filter(eq;like) ORD

Type: string (20)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 20
Show in UI: ShownByDefault

RentalAssetName

The name of the rental asset. Required Filter(like)

Type: string (254)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

StandardGuaranteeAmount

Standard default amount of the guarantee that is set for this asset when leased. Currency: StandardGuaranteeAmountCurrency Filter(multi eq)

Type: Amount (14, 2) nullable
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

TimePeriodType

Specifies the unit by which the periods of renting of this asset are measured. Filter(multi eq)

Type: TimePeriodType nullable
Category: System
Allowed values for the TimePeriodType(Applications.Rental.Assets.md#timeperiodtype) data attribute
Allowed Values (Applications.Rental.AssetsRepository.TimePeriodType Enum Members)

Value	Description
OvernightStays	OvernightStays value. Stored as 'D'. Database Value: 'D' Model Value: 0 Domain API Value: 'OvernightStays'
Months	Months value. Stored as 'M'. Database Value: 'M' Model Value: 1 Domain API Value: 'Months'
FullDays	Total count of complete days.. Stored as 'F'. Database Value: 'F' Model Value: 2 Domain API Value: 'FullDays'
v_24HourPeriods	Started 24-hour periods.. Stored as 'H'. Database Value: 'H' Model Value: 3 Domain API Value: 'v_24HourPeriods'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

AccountingAsset

When not null identifies the corresponding accounting asset. Filter(multi eq)

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

EnterpriseCompany

When not null, specifies that the asset is specific to a given enterprise company and may be used only in documents from this enterprise company. If null, the asset can be used in all enterprise companies. Filter(multi eq)

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

ManagedAsset

Link to a managed asset definition from the asset management module. It is used to manage, track and maintain the asset. Filter(multi eq) Introduced in version 24.1.4.74

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

Product

Product which is used in the store transactions for this asset. Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( ( obj.SerialNumber != null) AndAlso ( obj.SerialNumber.Product != obj.Product)), obj.SerialNumber.Product, obj.Product)

RentalAssetGroup

The logical group of the rental asset. Required Filter(multi eq)

Type: AssetGroups
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

RentalAssetType

The type of the asset. Required Filter(multi eq)

Type: AssetTypes
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

SalesProduct

Product which is used in the creation of Sales Orders to form the price of the service of renting this asset. Filter(multi eq)

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

SerialNumber

Serial number which in conjunction with the product for store operations allows for more accurate identification of the asset. Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( ( obj.SerialNumber != null) AndAlso ( obj.Product != obj.SerialNumber.Product)), null, obj.SerialNumber)

StandardGuaranteeAmountCurrency

Currency of the standard guarantee amount. Filter(multi eq)

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

WorkSchedule

Work schedule, which is used to calculate how many days this assets has been rented for (used only when the asset's lease by mode is by days). Filter(multi eq)

Type: WorkSchedules (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: 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