Logistics.Procurement.PurchaseControlDocumentLines Entity

Namespace: Logistics.Procurement

The detail line of purchase control data. The purchase control is used to tally all orders and execuctions in the purchasing module. Entity: Scm_Purchase_Control_Document_Lines (Introduced in version 18.2)

Default Visualization

Default Display Text Format:
{LineNo}. {PurchaseControlDocument.DocumentNo} {PurchaseControlDocument.DocumentType.TypeName:T}
Default Search Members:
PurchaseControlDocument.DocumentNo
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:
Logistics.Procurement.PurchaseControlDocuments
Aggregate Root:
Logistics.Procurement.PurchaseControlDocuments

Attributes

Name	Type	Description
ConfirmedAmountBase	decimal (14, 2) nullable	The amount (in base currency) of the ordered items, confirmed by the supplier (usually with Purchase Confirmation). Null when the logged operation did not involve confirming ordered items.
ConfirmedStandard QuantityBase	decimal (12, 3) nullable	The standard quantity of the ordered items, confirmed by the supplier (usually with Purchase Confirmation) in base measurement unit. Null when the logged operation did not involve confirming ordered items.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
InvoicedAmountBase	decimal (14, 2) nullable	The amount (in base currency) of the invoiced items (usually with Purchase Invoice). Null when the logged operation did not involve invoicing items.
InvoicedStandard QuantityBase	decimal (12, 3) nullable	The standard quantity of the invoiced items (usually with Purchase Invoice) in base measurement unit. Null when the logged operation did not involve invoicing items.
LineNo	int32	The consecutive line number within the control document. Required
Notes	string (max) nullable	Notes for this PurchaseControl DocumentLine.
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.
OrderedAmountBase	decimal (14, 2) nullable	The amount (in base currency) of the ordered items (usually with Purchase Order). Null when the logged operation did not involve ordering items.
OrderedStandard QuantityBase	decimal (12, 3) nullable	The standard quantity of the ordered items (usually with Purchase Order) in base measurement unit. Null when the logged operation did not involve ordering items.
ReceivedAmountBase	decimal (14, 2) nullable	The amount (in base currency) of the received items (usually with Receiving Order). Null when the logged operation did not involve receiving items.
ReceivedStandard QuantityBase	decimal (12, 3) nullable	The standard quantity of the received items (usually with Receiving Order) in base measurement unit. Null when the logged operation did not involve receiving items.
RequestedAmountBase	decimal (14, 2) nullable	The amount (in base currency) of the requested items (usually with Purchase Requisition). Null when the logged operation did not involve requesting items.
RequestedStandard QuantityBase	decimal (12, 3) nullable	The standard quantity of the requested items (usually with Purchase Requisition) in base measurement unit. Null when the logged operation did not involve requesting items.

References

Name	Type	Description
Document	PurchaseControlDocuments	OBSOLETE! Do not use! The to which this PurchaseControl DocumentLine belongs. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47
PurchaseControlDocument	PurchaseControlDocuments	OBSOLETE! Do not use! The to which this PurchaseControl DocumentLine belongs. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete Owner
PurchaseInvoice	PurchaseInvoices (nullable)	The purchase invoice which is to be or was executed. Null when the data is unknown. Filter(multi eq)
PurchaseInvoiceLine	PurchaseInvoiceLines (nullable)	The purchase invoice line which is to be or was executed. Null when the data is unknown. Filter(multi eq)
PurchaseOperationType	PurchaseOperationTypes (nullable)	OBSOLETE! Do not use! The user-defined operation type, which is being recorded by the current line. Used for better grouping of the control entries. null when the operation type was not specified by the user. Obsolete Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete
PurchaseOrder	PurchaseOrders (nullable)	The purchase order which is to be or was executed. Null when the data is unknown. Filter(multi eq)
PurchaseOrderLine	PurchaseOrderLines (nullable)	The purchase order line which is to be or was executed. Null when the data is unknown. Filter(multi eq)
PurchaseRequisition	Requisitions (nullable)	The purchase requisition which is to be or was executed. Null when the data is unknown. Filter(multi eq)
PurchaseRequisitionLine	RequisitionLines (nullable)	The purchase requisition line which is to be or was executed. Null when the data is unknown. Filter(multi eq)
ReceivingOrder	ReceivingOrders (nullable)	The receiving order which is to be or was executed. Null when the data is unknown. Filter(multi eq)
ReceivingOrderLine	ReceivingOrderLines (nullable)	The receiving order line which is to be or was executed. Null when the data is unknown. Filter(multi eq)

Attribute Details

ConfirmedAmountBase

The amount (in base currency) of the ordered items, confirmed by the supplier (usually with Purchase Confirmation). Null when the logged operation did not involve confirming ordered items.

Type: decimal (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ConfirmedStandardQuantityBase

The standard quantity of the ordered items, confirmed by the supplier (usually with Purchase Confirmation) in base measurement unit. Null when the logged operation did not involve confirming ordered items.

Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
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

InvoicedAmountBase

The amount (in base currency) of the invoiced items (usually with Purchase Invoice). Null when the logged operation did not involve invoicing items.

Type: decimal (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

InvoicedStandardQuantityBase

The standard quantity of the invoiced items (usually with Purchase Invoice) in base measurement unit. Null when the logged operation did not involve invoicing items.

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

LineNo

The consecutive line number within the control document. Required

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

Notes

Notes for this PurchaseControlDocumentLine.

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

OrderedAmountBase

The amount (in base currency) of the ordered items (usually with Purchase Order). Null when the logged operation did not involve ordering items.

Type: decimal (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

OrderedStandardQuantityBase

The standard quantity of the ordered items (usually with Purchase Order) in base measurement unit. Null when the logged operation did not involve ordering items.

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

ReceivedAmountBase

The amount (in base currency) of the received items (usually with Receiving Order). Null when the logged operation did not involve receiving items.

Type: decimal (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ReceivedStandardQuantityBase

The standard quantity of the received items (usually with Receiving Order) in base measurement unit. Null when the logged operation did not involve receiving items.

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

RequestedAmountBase

The amount (in base currency) of the requested items (usually with Purchase Requisition). Null when the logged operation did not involve requesting items.

Type: decimal (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

RequestedStandardQuantityBase

The standard quantity of the requested items (usually with Purchase Requisition) in base measurement unit. Null when the logged operation did not involve requesting items.

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

Reference Details

Document

OBSOLETE! Do not use! The to which this PurchaseControlDocumentLine belongs. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47

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

PurchaseControlDocument

OBSOLETE! Do not use! The to which this PurchaseControlDocumentLine belongs. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete Owner

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

PurchaseInvoice

The purchase invoice which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

PurchaseInvoiceLine

The purchase invoice line which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

PurchaseOperationType

OBSOLETE! Do not use! The user-defined operation type, which is being recorded by the current line. Used for better grouping of the control entries. null when the operation type was not specified by the user. Obsolete Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete

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

PurchaseOrder

The purchase order which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

PurchaseOrderLine

The purchase order line which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

PurchaseRequisition

The purchase requisition which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

PurchaseRequisitionLine

The purchase requisition line which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

ReceivingOrder

The receiving order which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

ReceivingOrderLine

The receiving order line which is to be or was executed. Null when the data is unknown. Filter(multi eq)

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

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

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  The notification 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_PurchaseControlDocumentLines?$top=10

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