Logistics.Shipment.Carriers Entity

Namespace: Logistics.Shipment

Represents a carrier agreement. One actual carrier can have different agreements over time or with different enterprise companies. Entity: Log_Carriers

Default Visualization

Default Display Text Format:
{Code}: {Supplier.Party.PartyName:T}
Default Search Members:
Code
Code Data Member:
Code
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

Logistics.Shipment.Carriers

Attributes

Name	Type	Description
AgreementEndDate	date nullable	The ending date of the agreement with this carrier. null for agreements which are still active. `Filter(eq;ge;le)`
AgreementStartDate	date	The start date of the agreement with this carrier. `Required` `Default(Today)` `Filter(eq;ge;le)`
Code	string (16)	Unique carrier code (or call sign). The code is unique within all enterprise companies. `Required` `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsActive	boolean	Specifies whether the carrier agreement is active. `Required` `Default(true)` `Filter(eq)`
Notes	string (max) nullable	Notes for this Carrier.
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.

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies	The enterprise company which signed the carrier agreement. `Required` `Filter(multi eq)`
Supplier	Suppliers	The supplier contract with the carrier. `Required` `Filter(multi eq)`

Attribute Details

AgreementEndDate

The ending date of the agreement with this carrier. null for agreements which are still active. Filter(eq;ge;le)

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

AgreementStartDate

The start date of the agreement with this carrier. Required Default(Today) Filter(eq;ge;le)

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

Code

Unique carrier code (or call sign). The code is unique within all enterprise companies. Required Filter(eq;like) ORD

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

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

Specifies whether the carrier agreement is active. 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 Carrier.

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

Reference Details

EnterpriseCompany

The enterprise company which signed the carrier agreement. Required Filter(multi eq)

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

Supplier

The supplier contract with the carrier. Required Filter(multi eq)

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