| uid |
|---|
Logistics.Shipment.Carriers |
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 Display Text Format:
{Code}: {Supplier.Party.PartyName:T}
Default Search Members:
Code
Code Data Member:
Code
Category: Definitions
Show in UI: ShownByDefault
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
| 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. |
| 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) |
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
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
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
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
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
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 for this Carrier.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
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
The enterprise company which signed the carrier agreement. Required Filter(multi eq)
Type: EnterpriseCompanies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
The supplier contract with the carrier. Required Filter(multi eq)
Type: Suppliers
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Methods that can be invoked in public APIs.
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
Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
-
user
The user.
Type: Users -
notificationClass
The notification class.
Type: string -
subject
The subject.
Type: string
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
[!list limit=1000 erp.entity=Logistics.Shipment.Carriers erp.type=business-rule default-text="None"]
[!list limit=1000 erp.entity=Logistics.Shipment.Carriers erp.type=front-end-business-rule default-text="None"]
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Logistics_Shipment_Carriers?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Logistics_Shipment_Carriers?$top=10