General.Resources.ResourceCostRates Entity

Namespace: General.Resources

Contains cost rates for different periods for resources. Each record is valid until the next From Date. Entity: Gen_Resource_Cost_Rates

Default Visualization

Default Display Text Format:
{Resource.Name:T}
Default Search Members:
Resource.Name
Name Data Member:
Resource.Name
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:
General.Resources.Resources
Aggregate Root:
General.Resources.ResourceGroups

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	Starting date of validity of the cost rate. The rate is valid until the next cost rate record with later date is defined. `Required` `Filter(eq;ge;le)`
Id	guid
Notes	string (max) nullable	Notes for this ResourceCostRate.
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.
OvertimeRatePerHour	Amount (12, 4) nullable	The overtime cost of the resource per hour in the resources costing currency. The overtime rate specifies the cost of the resource, when it is used outside the normal working schedule. null means that there is no special overtime rate and the standard rate should be applied. `Currency: Resource.CostingCurrency` `Filter(eq;like)`
PerUseCost	Amount (12, 2)	One-time cost for each usage of the resource in the resources costing currency. `Currency: Resource.CostingCurrency` `Required` `Default(0)` `Filter(eq;like)`
StandardRatePerHour	Amount (12, 4)	The standard cost per hour of the resource in the resources costing currency. The standard cost is applied for resource usage during the normal working hours. `Currency: Resource.CostingCurrency` `Required` `Filter(eq;like)`

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies	The enterprise company for which the cost is defined. `Required` `Filter(multi eq)`
Resource	Resources	The resource for which the cost rate 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

FromDate

Starting date of validity of the cost rate. The rate is valid until the next cost rate record with later date is defined. Required Filter(eq;ge;le)

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
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

Notes

Notes for this ResourceCostRate.

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

OvertimeRatePerHour

The overtime cost of the resource per hour in the resources costing currency. The overtime rate specifies the cost of the resource, when it is used outside the normal working schedule. null means that there is no special overtime rate and the standard rate should be applied. Currency: Resource.CostingCurrency Filter(eq;like)

Type: Amount (12, 4) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

PerUseCost

One-time cost for each usage of the resource in the resources costing currency. Currency: Resource.CostingCurrency Required Default(0) Filter(eq;like)

Type: Amount (12, 2)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

StandardRatePerHour

The standard cost per hour of the resource in the resources costing currency. The standard cost is applied for resource usage during the normal working hours. Currency: Resource.CostingCurrency Required Filter(eq;like)

Type: Amount (12, 4)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

EnterpriseCompany

The enterprise company for which the cost is defined. Required Filter(multi eq)

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

Resource

The resource for which the cost rate is defined. Required Filter(multi eq) Owner

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