Show / Hide Table of Contents

    General.DocumentFulfillments Entity

    Namespace: General

    Fulfillment ledger for documents. Entity: Gen_Document_Fulfillments (Introduced in version 20.1)

    Default Visualization

    Default Display Text Format:
    {DestinationEntityName}
    Default Search Members:
    DestinationEntityName
    Name Data Member:
    DestinationEntityName
    Category: Definitions
    Show in UI: ShownByDefault

    Aggregate

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

    Aggregate Parent:
    General.Documents
    Aggregate Root:
    General.Documents

    Attributes

    Name Type Description
    CreationTimeUtc datetime The exact time in UTC, when the fulfillment was created in the system. Required Default(NowUtc) Filter(multi eq;ge;le)
    DestinationEntityName string (64) The name of the entity which fulfills the line. Used to differentiate between different fulfillment types. For example, sales order line can be fulfilled, for different purposes, by store order line and invoice order line. Required Default("") Filter(eq) Introduced in version 22.1.4.7
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    DocumentLineId guid The Id of the fulfilled line within the document. The attribute contains the Id and is not a reference, because it references different entities depending on document entity type and line type. Required Filter(multi eq)
    FulfillmentType FulfillmentType Type of fulfillment: P=Planned; C=Completed. Required Filter(multi eq) Introduced in version 21.1.1.26
    Id guid
    IsFinal boolean Specifies whether this fulfillment finalizes the line, regardless of any remaining quantities. Required Filter(eq)
    LineNo int32 nullable Line number. Used for human-readability of the fulfillment. null if the lines do not support line numbers or the line number is unknown. Filter(multi eq;ge;le) Introduced in version 21.1.1.26
    LineType string (1) Detail (line) type, for example materials, services, etc. L=Line. Other values are defined by the document entity type. Required Default("L") Filter(multi eq) Introduced in version 21.1.1.26
    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.
    QuantityBase decimal (12, 3) Fulfilled quantity in the base measurement unit of the product. Required Filter(multi eq;ge;le) Introduced in version 21.1.1.33
    StandardQuantity decimal (12, 3) The theoretical quantity according to the current measurement dimensions for the product. Used to measure the execution. Required Introduced in version 22.1.4.52

    References

    Name Type Description
    CreationUser Users The user, who created the record. Required Filter(multi eq)
    Document Documents The Document, which is fulfilled. Required Filter(multi eq) ReadOnly Introduced in version 21.1.1.26 Owner
    Lot Lots (nullable) The lot, which was fulfilled. null when the fulfillment was not for a specific lot. Filter(multi eq) Introduced in version 22.1.4.52
    ParentFulfillment DocumentFulfillments (nullable) The parent document fulfillment. Used when the information of the current fulfillment is inherited by another document fulfillment, usually created by another module. Filter(multi eq) Introduced in version 22.1.5.85
    Product Products (nullable) The product, which is fulfilled. Filter(multi eq) Introduced in version 22.1.4.52
    ProductVariant ProductVariants (nullable) The product variant, which was fulfilled. null when the fulfillment was not for a product variant. Filter(multi eq) Introduced in version 22.1.4.52
    SerialNumber SerialNumbers (nullable) The serial number, which was fulfilled. null when the fulfillment was not for a specific serial number. Filter(multi eq) Introduced in version 22.1.4.52

    Attribute Details

    CreationTimeUtc

    The exact time in UTC, when the fulfillment was created in the system. Required Default(NowUtc) Filter(multi eq;ge;le)

    Type: datetime
    Category: System
    Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
    Supports Order By: False
    Default Value: CurrentDateTimeUtc
    Show in UI: ShownByDefault

    DestinationEntityName

    The name of the entity which fulfills the line. Used to differentiate between different fulfillment types. For example, sales order line can be fulfilled, for different purposes, by store order line and invoice order line. Required Default("") Filter(eq) Introduced in version 22.1.4.7

    Type: string (64)
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Maximum Length: 64
    Default Value: ****
    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

    DocumentLineId

    The Id of the fulfilled line within the document. The attribute contains the Id and is not a reference, because it references different entities depending on document entity type and line type. Required Filter(multi eq)

    Type: guid
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Show in UI: ShownByDefault

    FulfillmentType

    Type of fulfillment: P=Planned; C=Completed. Required Filter(multi eq) Introduced in version 21.1.1.26

    Type: FulfillmentType
    Category: System
    Allowed values for the FulfillmentType(General.DocumentFulfillments.md#fulfillmenttype) data attribute
    Allowed Values (General.DocumentFulfillmentsRepository.FulfillmentType Enum Members)

    Value Description
    Planned Planned value. Stored as 'P'.
    Database Value: 'P'
    Model Value: 0
    Domain API Value: 'Planned'
    Completed Completed value. Stored as 'C'.
    Database Value: 'C'
    Model Value: 1
    Domain API Value: 'Completed'

    Supported Filters: Equals, EqualsIn
    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

    IsFinal

    Specifies whether this fulfillment finalizes the line, regardless of any remaining quantities. Required Filter(eq)

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Show in UI: ShownByDefault

    LineNo

    Line number. Used for human-readability of the fulfillment. null if the lines do not support line numbers or the line number is unknown. Filter(multi eq;ge;le) Introduced in version 21.1.1.26

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

    LineType

    Detail (line) type, for example materials, services, etc. L=Line. Other values are defined by the document entity type. Required Default("L") Filter(multi eq) Introduced in version 21.1.1.26

    Type: string (1)
    Category: System
    Supported Filters: Equals, EqualsIn
    Supports Order By: False
    Maximum Length: 1
    Default Value: L
    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

    QuantityBase

    Fulfilled quantity in the base measurement unit of the product. Required Filter(multi eq;ge;le) Introduced in version 21.1.1.33

    Type: decimal (12, 3)
    Category: System
    Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
    Supports Order By: False
    Show in UI: ShownByDefault

    StandardQuantity

    The theoretical quantity according to the current measurement dimensions for the product. Used to measure the execution. Required Introduced in version 22.1.4.52

    Type: decimal (12, 3)
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Show in UI: ShownByDefault

    Reference Details

    CreationUser

    The user, who created the record. Required Filter(multi eq)

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

    Document

    The Document, which is fulfilled. Required Filter(multi eq) ReadOnly Introduced in version 21.1.1.26 Owner

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

    Lot

    The lot, which was fulfilled. null when the fulfillment was not for a specific lot. Filter(multi eq) Introduced in version 22.1.4.52

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

    ParentFulfillment

    The parent document fulfillment. Used when the information of the current fulfillment is inherited by another document fulfillment, usually created by another module. Filter(multi eq) Introduced in version 22.1.5.85

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

    Product

    The product, which is fulfilled. Filter(multi eq) Introduced in version 22.1.4.52

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

    ProductVariant

    The product variant, which was fulfilled. null when the fulfillment was not for a product variant. Filter(multi eq) Introduced in version 22.1.4.52

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

    SerialNumber

    The serial number, which was fulfilled. null when the fulfillment was not for a specific serial number. Filter(multi eq) Introduced in version 22.1.4.52

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

    • R32489 DocumentFulfillments - Creation Time Utc

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX