Logistics.Procurement.Suppliers Entity

Namespace: Logistics.Procurement

Contains supplier conditions (contracts). Entity: Scm_Suppliers

Default Visualization

Default Display Text Format:
{Party.PartyName:T}
Default Search Members:
Number; Party.PartyName
Code Data Member:
Number
Name Data Member:
Party.PartyName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Attributes

Name Type Description
CreationTime datetime nullable Date and time when the Supplier was created. Filter(ge;le) ReadOnly
CreationUser string (64) nullable Login name of the user, who created the Supplier. Filter(like) ReadOnly
DefaultDeliveryTermDays int32 Default term in days for goods delivery, starting at the day of sending the purchase order. Required Default(0)
DefaultPaymentStartDays int32 Default number of days until the payment becomes executable. 0 means that the payment is executable at all times. Required Default(0)
DefaultPaymentTermDays int32 Default payment term in days, starting from the date of receiving the invoice. Required Default(0)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate datetime nullable The date on which this party became a supplier or the date, when the supplier contract was signed. Filter(ge;le)
Id guid
IsActive boolean Indicates whether the current supplier is active. Required Default(true) Filter(eq)
Number string (16) nullable The unique supplier number. Filter(eq;like) ORD
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.
ThruDate datetime nullable The date (inclusive) on which this party ceased to be a supplier. Filter(ge;le)
UpdateTime datetime nullable Date and time when the Supplier was last updated. Filter(ge;le) ReadOnly
UpdateUser string (64) nullable Login name of the user, who last updated the Supplier. Filter(like) ReadOnly

References

Name Type Description
DefaultCurrency Currencies (nullable) The default currency for purchases from this supplier. null means there is no default. Filter(multi eq)
DefaultPaymentAccount PaymentAccounts (nullable) When not null, specifies the default payment account which should be used for new purchase document for this supplier. Filter(multi eq)
DefaultPaymentType PaymentTypes (nullable) When not null, specifies the default payment type which should be used for new purchase document for this supplier. Filter(multi eq)
DefaultPurchasePriceList PurchasePriceLists (nullable) The default purchase price list, which shall be used for new purchase documents for this supplier. Filter(multi eq)
EnterpriseCompany EnterpriseCompanies (nullable) The Enterprise Company to which this Supplier applies, or null if it is for all enterprise companies. Filter(multi eq)
Party Parties The party who is the supplier for the enterprise company. Required Filter(multi eq) FilterableReference
SupplierType SupplierTypes (nullable) When not null, specifies the type of this supplier. The type is primarily used for security access differentiation of the supplier records. Filter(multi eq)

Attribute Details

CreationTime

Date and time when the Supplier was created. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

CreationUser

Login name of the user, who created the Supplier. Filter(like) ReadOnly

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: HiddenByDefault

DefaultDeliveryTermDays

Default term in days for goods delivery, starting at the day of sending the purchase order. Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

DefaultPaymentStartDays

Default number of days until the payment becomes executable. 0 means that the payment is executable at all times. Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

DefaultPaymentTermDays

Default payment term in days, starting from the date of receiving the invoice. Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
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

FromDate

The date on which this party became a supplier or the date, when the supplier contract was signed. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: 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

IsActive

Indicates whether the current supplier 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

Number

The unique supplier number. Filter(eq;like) ORD

Type: string (16) nullable
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
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

ThruDate

The date (inclusive) on which this party ceased to be a supplier. Filter(ge;le)

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

UpdateTime

Date and time when the Supplier was last updated. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

UpdateUser

Login name of the user, who last updated the Supplier. Filter(like) ReadOnly

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: HiddenByDefault

Reference Details

DefaultCurrency

The default currency for purchases from this supplier. null means there is no default. Filter(multi eq)

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

DefaultPaymentAccount

When not null, specifies the default payment account which should be used for new purchase document for this supplier. Filter(multi eq)

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

DefaultPaymentType

When not null, specifies the default payment type which should be used for new purchase document for this supplier. Filter(multi eq)

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

DefaultPurchasePriceList

The default purchase price list, which shall be used for new purchase documents for this supplier. Filter(multi eq)

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

EnterpriseCompany

The Enterprise Company to which this Supplier applies, or null if it is for all enterprise companies. Filter(multi eq)

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

Party

The party who is the supplier for the enterprise company. Required Filter(multi eq) FilterableReference

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

SupplierType

When not null, specifies the type of this supplier. The type is primarily used for security access differentiation of the supplier records. Filter(multi eq)

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

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

CreateCopy

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

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Logistics_Procurement_Suppliers?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Logistics_Procurement_Suppliers?$top=10