Applications.Rental.LeaseContractLines Entity

Namespace: Applications.Rental

The detail lines of rental contracts. Each line contains rental conditions for one asset of the rental contract. Entity: Rent_Lease_Contract_Lines

Default Visualization

Default Display Text Format:
{LeaseContract.EntityName}
Default Search Members:
LeaseContract.EntityName
Name Data Member:
LeaseContract.EntityName
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:
Applications.Rental.LeaseContracts
Aggregate Root:
Applications.Rental.LeaseContracts

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EndDate	date	Ending date of lease of this asset. `Required` `Filter(multi eq;ge;le)`
GuaranteeAmount	Amount (14, 2) nullable	Deposit amount in the currency of the document which is given for this asset during its period of lease. `Currency: LeaseContract.Currency`
Id	guid
LineNo	int32	Consecutive number of the line within the lease contract. `Required` `Filter(eq;ge;le)`
LineNotes	string (max) nullable	Notes for this line.
NumberOfPeriods	int32 nullable	Number of periods calculated based on the Start Date and End Date of the lease, and the Time Period Type defined for the asset. `Filter(eq;ge;le)` `Introduced in version 24.1.5.21`
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.
StartDate	date	Starting date of lease for this asset. `Required` `Filter(multi eq;ge;le)`
TimePeriodType	TimePeriodType nullable	Specifies the unit by which the periods of renting of this asset are measured. `Filter(multi eq)` `Introduced in version 24.1.5.31`

References

Name	Type	Description
LeaseContract	LeaseContracts	The to which this LeaseContractLine belongs. `Required` `Filter(multi eq)` `Owner`
RentalAsset	Assets	The asset which is rented with the current contract. `Required` `Filter(multi eq)`

Child Collections

Name	Type	Description
Consumables	LeaseContractLineConsumables	List of `LeaseContract<br />LineConsumable`(Applications.Rental.LeaseContractLine Consumables.md) child objects, based on the `Applications.Rental.LeaseContractLine<br />Consumable.LeaseLine`(Applications.Rental.LeaseContractLine Consumables.md#leaseline) 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

EndDate

Ending date of lease of this asset. Required Filter(multi eq;ge;le)

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

Back-End Default Expression:
obj.LeaseContract.EndDate

Front-End Recalc Expressions:
obj.LeaseContract.EndDate

GuaranteeAmount

Deposit amount in the currency of the document which is given for this asset during its period of lease. Currency: LeaseContract.Currency

Type: Amount (14, 2) nullable
Category: System
Supported Filters: NotFilterable
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

LineNo

Consecutive number of the line within the lease contract. Required Filter(eq;ge;le)

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

Back-End Default Expression:
( obj.LeaseContract.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.LeaseContract.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

LineNotes

Notes for this line.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

NumberOfPeriods

Number of periods calculated based on the Start Date and End Date of the lease, and the Time Period Type defined for the asset. Filter(eq;ge;le) Introduced in version 24.1.5.21

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

Front-End Recalc Expressions:
obj.CalculateNumberOfPeriods( obj.RentalAsset, obj.StartDate, obj.EndDate, obj.TimePeriodType)

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

StartDate

Starting date of lease for this asset. Required Filter(multi eq;ge;le)

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

Back-End Default Expression:
obj.LeaseContract.StartDate

Front-End Recalc Expressions:
obj.LeaseContract.StartDate

TimePeriodType

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

Type: TimePeriodType nullable
Category: System
Allowed values for the TimePeriodType(Applications.Rental.LeaseContractLines.md#timeperiodtype) data attribute
Allowed Values (Applications.Rental.LeaseContractLinesRepository.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

Front-End Recalc Expressions:
Convert( obj.RentalAsset.TimePeriodType, Nullable1)`

Reference Details

LeaseContract

The to which this LeaseContractLine belongs. Required Filter(multi eq) Owner

Type: LeaseContracts
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

RentalAsset

The asset which is rented with the current contract. Required Filter(multi eq)

Type: Assets
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