Table of Contents

Logistics.Procurement.PurchaseInvoiceLines Entity

Namespace: Logistics.Procurement

Contains detail lines for purchase invoice documents. Entity: Scm_Purchase_Invoice_Lines

Default Visualization

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

Attributes

Name Type Description
CurrentBalanceBase Quantity The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.
DeliveryTermsCode DeliveryTerms nullable Mode of delivery, like CIF, FOB, etc. Used also in Intrastat reporting.
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IntrastatApplyDate datetime nullable Specifies in which period for Intrastat declaration must be included the current operation. Used only when the invoice is issued in different period than the one, that the operation must be included. If not set the document date is used. Filter(ge;le)
IntrastatTransaction
NatureCode		 TransactionNature nullable Transaction nature; used for Intrastat reporting.
IntrastatTransportModeCode TransportMode nullable Transport mode; used for Intrastat reporting.
LineAmount Amount (14, 2) The total invoiced amount for this line in the document currency of the invoice. Currency: PurchaseInvoice.DocumentCurrency Required Default(0)
LineNo int32 Consecutive line number within the invoice. Required
Notes string (254) nullable Notes for this PurchaseInvoiceLine.
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.
ProductName MultilanguageString (254) The name of the invoiced product, initially copied from the name in the product definition. The field can be edited by the user. Required
Quantity Quantity (12, 3) The invoiced quantity. Unit: QuantityUnit Required Default(1)
QuantityBase Quantity (12, 3) The equivalence of Quantity in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required
StandardQuantityBase Quantity (12, 3) The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2
UnitPrice Amount (14, 5) The unit price of the invoiced item in the document currency of the invoice. Currency: PurchaseInvoice.DocumentCurrency Required Default(0)

References

Name Type Description
Document PurchaseInvoices The to which this PurchaseInvoiceLine belongs. Required Filter(multi eq)
IntrastatDestinationRegion AdministrativeRegions (nullable) Region, which is the final destination of the goods. Used for Intrastat reporting. Filter(multi eq)
IntrastatTransportCountry Countries (nullable) Country of origin of the transport company; used for Intrastat reporting. Filter(multi eq)
LineCostCenter CostCenters (nullable) Cost center for which the amount from this row will be accounted. Filter(multi eq)
LineDealType DealTypes (nullable) Deal type for this line. If deal type in the line is different from deal type in the header another VAT entry is created. Filter(multi eq)
OriginCountry Countries (nullable) The country of origin of the invoiced product. Should be non-null only when this is different from the country of origin from the product definition. Filter(multi eq)
Product Products The invoiced product. Required Filter(multi eq)
PurchaseInvoice PurchaseInvoices The to which this PurchaseInvoiceLine belongs. Required Filter(multi eq) Owner
QuantityUnit MeasurementUnits The measurement unit of Quantity. Required Filter(multi eq)
ReceivingOrderLine ReceivingOrderLines (nullable) The receiving order line, which is invoiced by the current line. null means that this line is not directly related to receiving order line. Filter(multi eq)
SaleLineDealType DealTypes (nullable) Sale deal type for this line. If sale deal type in the line is different from sale deal type in the header another Sales VAT entry is created. Filter(multi eq)

Attribute Details

CurrentBalanceBase

The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.

Type: Quantity
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

DeliveryTermsCode

Mode of delivery, like CIF, FOB, etc. Used also in Intrastat reporting.

Type: DeliveryTerms nullable
Category: System
Generic enum type for DeliveryTerms properties
Allowed Values (Finance.Intrastat.DeliveryTerms Enum Members)

Value Description
ExWorks ExWorks value. Stored as 'EXW'.
Database Value: 'EXW'
Model Value: 0
Domain API Value: 'ExWorks'
FrancoCarrier FrancoCarrier value. Stored as 'FCA'.
Database Value: 'FCA'
Model Value: 1
Domain API Value: 'FrancoCarrier'
FreeAlongsideShip FreeAlongsideShip value. Stored as 'FAS'.
Database Value: 'FAS'
Model Value: 2
Domain API Value: 'FreeAlongsideShip'
FreeOnBoard FreeOnBoard value. Stored as 'FOB'.
Database Value: 'FOB'
Model Value: 3
Domain API Value: 'FreeOnBoard'
CostAndFreightCF CostAndFreightCF value. Stored as 'CFR'.
Database Value: 'CFR'
Model Value: 4
Domain API Value: 'CostAndFreightCF'
CostInsuranceAndFreight CostInsuranceAndFreight value. Stored as 'CIF'.
Database Value: 'CIF'
Model Value: 5
Domain API Value: 'CostInsuranceAndFreight'
CarriagePaidTo CarriagePaidTo value. Stored as 'CPT'.
Database Value: 'CPT'
Model Value: 6
Domain API Value: 'CarriagePaidTo'
CarriageAndInsurancePaidTo CarriageAndInsurancePaidTo value. Stored as 'CIP'.
Database Value: 'CIP'
Model Value: 7
Domain API Value: 'CarriageAndInsurancePaidTo'
DeliveredAtPlace DeliveredAtPlace value. Stored as 'DAP'.
Database Value: 'DAP'
Model Value: 8
Domain API Value: 'DeliveredAtPlace'
DeliveredAtTerminal DeliveredAtTerminal value. Stored as 'DAT'.
Database Value: 'DAT'
Model Value: 9
Domain API Value: 'DeliveredAtTerminal'
DeliveredDutyPaid DeliveredDutyPaid value. Stored as 'DDP'.
Database Value: 'DDP'
Model Value: 10
Domain API Value: 'DeliveredDutyPaid'
DeliveredAtPlaceUnloaded DeliveredAtPlaceUnloaded value. Stored as 'DPU'.
Database Value: 'DPU'
Model Value: 11
Domain API Value: 'DeliveredAtPlaceUnloaded'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.PurchaseInvoice.DeliveryTermsCode

Front-End Recalc Expressions:
obj.PurchaseInvoice.DeliveryTermsCode

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

IntrastatApplyDate

Specifies in which period for Intrastat declaration must be included the current operation. Used only when the invoice is issued in different period than the one, that the operation must be included. If not set the document date is used. Filter(ge;le)

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

IntrastatTransactionNatureCode

Transaction nature; used for Intrastat reporting.

Type: TransactionNature nullable
Category: System
Generic enum type for TransactionNature properties
Allowed Values (Finance.Intrastat.TransactionNature Enum Members)

Value Description
OutrightPurchaseOrSale OutrightPurchaseOrSale value. Stored as '11'.
Database Value: '11'
Model Value: 0
Domain API Value: 'OutrightPurchaseOrSale'
SupplyForSale SupplyForSale value. Stored as '12'.
Database Value: '12'
Model Value: 1
Domain API Value: 'SupplyForSale'
BarterTrade BarterTrade value. Stored as '13'.
Database Value: '13'
Model Value: 2
Domain API Value: 'BarterTrade'
FinancialLeasing FinancialLeasing value. Stored as '14'.
Database Value: '14'
Model Value: 3
Domain API Value: 'FinancialLeasing'
OtherTransactions OtherTransactions value. Stored as '19'.
Database Value: '19'
Model Value: 4
Domain API Value: 'OtherTransactions'
ReturnStokilizing ReturnStokilizing value. Stored as '21'.
Database Value: '21'
Model Value: 5
Domain API Value: 'ReturnStokilizing'
ReplacementFor
ReturnedGoods		 ReplacementFor
ReturnedGoods value. Stored as '22'.
Database Value: '22'
Model Value: 6
Domain API Value: 'ReplacementFor
ReturnedGoods'
ReplacementOfGoods
NotBeingReturned		 ReplacementOfGoods
NotBeingReturned value. Stored as '23'.
Database Value: '23'
Model Value: 7
Domain API Value: 'ReplacementOfGoods
NotBeingReturned'
ReturnOrExchange
OfOtherGoods		 ReturnOrExchange
OfOtherGoods value. Stored as '29'.
Database Value: '29'
Model Value: 8
Domain API Value: 'ReturnOrExchange
OfOtherGoods'
SpecificTransactions SpecificTransactions value. Stored as '60'.
Database Value: '60'
Model Value: 9
Domain API Value: 'SpecificTransactions'
OperationsOnJointProjects OperationsOnJointProjects value. Stored as '70'.
Database Value: '70'
Model Value: 10
Domain API Value: 'OperationsOnJointProjects'
TransactionsOf
ConstructionMaterials
AndEquipment		 TransactionsOf
ConstructionMaterials
AndEquipment value. Stored as '80'.
Database Value: '80'
Model Value: 11
Domain API Value: 'TransactionsOf
ConstructionMaterials
AndEquipment'
OtherTransactionsLeasing OtherTransactionsLeasing value. Stored as '91'.
Database Value: '91'
Model Value: 12
Domain API Value: 'OtherTransactionsLeasing'
OtherTransactionsOther OtherTransactionsOther value. Stored as '99'.
Database Value: '99'
Model Value: 13
Domain API Value: 'OtherTransactionsOther'
DealsThatInclude
PropertyTransfers
WithoutFinancial
CompensationOr
CompensationIn
Kind		 DealsThatInclude
PropertyTransfers
WithoutFinancial
CompensationOr
CompensationIn
Kind value. Stored as '30'.
Database Value: '30'
Model Value: 14
Domain API Value: 'DealsThatInclude
PropertyTransfers
WithoutFinancial
CompensationOr
CompensationIn
Kind'
GoodsThatAreExpected
ToBeReturnedTo
Sender		 GoodsThatAreExpected
ToBeReturnedTo
Sender value. Stored as '41'.
Database Value: '41'
Model Value: 15
Domain API Value: 'GoodsThatAreExpected
ToBeReturnedTo
Sender'
GoodsThatAreNot
ExpectedToBeReturned
ToSender		 GoodsThatAreNot
ExpectedToBeReturned
ToSender value. Stored as '42'.
Database Value: '42'
Model Value: 16
Domain API Value: 'GoodsThatAreNot
ExpectedToBeReturned
ToSender'
GoodsThatAreReturned
ToSender		 GoodsThatAreReturned
ToSender value. Stored as '51'.
Database Value: '51'
Model Value: 17
Domain API Value: 'GoodsThatAreReturned
ToSender'
GoodsThatAreNot
ReturnedToSender		 GoodsThatAreNot
ReturnedToSender value. Stored as '52'.
Database Value: '52'
Model Value: 18
Domain API Value: 'GoodsThatAreNot
ReturnedToSender'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.PurchaseInvoice.IntrastatTransactionNatureCode

Front-End Recalc Expressions:
obj.PurchaseInvoice.IntrastatTransactionNatureCode

IntrastatTransportModeCode

Transport mode; used for Intrastat reporting.

Type: TransportMode nullable
Category: System
Generic enum type for TransportMode properties
Allowed Values (Finance.Intrastat.TransportMode Enum Members)

Value Description
Shipping Shipping value. Stored as '1'.
Database Value: '1'
Model Value: 0
Domain API Value: 'Shipping'
RailwayTransport RailwayTransport value. Stored as '2'.
Database Value: '2'
Model Value: 1
Domain API Value: 'RailwayTransport'
RoadTransport RoadTransport value. Stored as '3'.
Database Value: '3'
Model Value: 2
Domain API Value: 'RoadTransport'
AirTransport AirTransport value. Stored as '4'.
Database Value: '4'
Model Value: 3
Domain API Value: 'AirTransport'
Mail Mail value. Stored as '5'.
Database Value: '5'
Model Value: 4
Domain API Value: 'Mail'
FixedTransport
Installations		 FixedTransport
Installations value. Stored as '7'.
Database Value: '7'
Model Value: 5
Domain API Value: 'FixedTransport
Installations'
RiverTransport RiverTransport value. Stored as '8'.
Database Value: '8'
Model Value: 6
Domain API Value: 'RiverTransport'
SelfPropelled SelfPropelled value. Stored as '9'.
Database Value: '9'
Model Value: 7
Domain API Value: 'SelfPropelled'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.PurchaseInvoice.IntrastatTransportModeCode

Front-End Recalc Expressions:
obj.PurchaseInvoice.IntrastatTransportModeCode

LineAmount

The total invoiced amount for this line in the document currency of the invoice. Currency: PurchaseInvoice.DocumentCurrency Required Default(0)

Type: Amount (14, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

LineNo

Consecutive line number within the invoice. Required

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

Back-End Default Expression:
( obj.PurchaseInvoice.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.PurchaseInvoice.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Notes

Notes for this PurchaseInvoiceLine.

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

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

ProductName

The name of the invoiced product, initially copied from the name in the product definition. The field can be edited by the user. Required

Type: MultilanguageString (254)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.Product.Name

Front-End Recalc Expressions:
IIF( ( obj.ReceivingOrderLine != null), obj.ReceivingOrderLine.ProductDescription, obj.Product.Name)

Quantity

The invoiced quantity. Unit: QuantityUnit Required Default(1)

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

Front-End Recalc Expressions:
IIF( ( obj.ReceivingOrderLine != null), obj.ReceivingOrderLine.ConfirmedQuantity.IfNullThen( obj.ReceivingOrderLine.Quantity), obj.Quantity)

QuantityBase

The equivalence of Quantity in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required

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

Back-End Default Expression:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.QuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.QuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

StandardQuantityBase

The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2

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

Back-End Default Expression:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.StandardQuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.StandardQuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

UnitPrice

The unit price of the invoiced item in the document currency of the invoice. Currency: PurchaseInvoice.DocumentCurrency Required Default(0)

Type: Amount (14, 5)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( obj.ReceivingOrderLine != null), obj.ReceivingOrderLine.PricePerUnit, obj.GetDefaultProductPrice( obj.Product))

Reference Details

Document

The to which this PurchaseInvoiceLine belongs. Required Filter(multi eq)

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

IntrastatDestinationRegion

Region, which is the final destination of the goods. Used for Intrastat reporting. Filter(multi eq)

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

Back-End Default Expression:
obj.PurchaseInvoice.IntrastatDestinationRegion

Front-End Recalc Expressions:
obj.PurchaseInvoice.IntrastatDestinationRegion

IntrastatTransportCountry

Country of origin of the transport company; used for Intrastat reporting. Filter(multi eq)

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

Back-End Default Expression:
obj.PurchaseInvoice.IntrastatTransportCountry

Front-End Recalc Expressions:
obj.PurchaseInvoice.IntrastatTransportCountry

LineCostCenter

Cost center for which the amount from this row will be accounted. Filter(multi eq)

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

LineDealType

Deal type for this line. If deal type in the line is different from deal type in the header another VAT entry is created. Filter(multi eq)

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

Back-End Default Expression:
obj.PurchaseInvoice.DealType

Front-End Recalc Expressions:
obj.PurchaseInvoice.DealType

OriginCountry

The country of origin of the invoiced product. Should be non-null only when this is different from the country of origin from the product definition. Filter(multi eq)

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

Product

The invoiced product. Required Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( obj.ReceivingOrderLine != null), obj.ReceivingOrderLine.Product, obj.Product)

PurchaseInvoice

The to which this PurchaseInvoiceLine belongs. Required Filter(multi eq) Owner

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

QuantityUnit

The measurement unit of Quantity. Required Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( obj.ReceivingOrderLine != null), obj.ReceivingOrderLine.QuantityUnit, IIF( ( obj.Product != null), obj.Product.MeasurementUnit, obj.QuantityUnit))

ReceivingOrderLine

The receiving order line, which is invoiced by the current line. null means that this line is not directly related to receiving order line. Filter(multi eq)

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

SaleLineDealType

Sale deal type for this line. If sale deal type in the line is different from sale deal type in the header another Sales VAT entry is created. Filter(multi eq)

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

Back-End Default Expression:
obj.PurchaseInvoice.SaleDealType

Front-End Recalc Expressions:
obj.PurchaseInvoice.SaleDealType

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

API

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

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

Suggest improvement to this page