Click or drag to resize

ESDRecordOrderPurchaseLine Class

Ecommerce Standards Record that holds data for a single line in a purchase order.
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDRecordOrderPurchaseLine

Namespace:  EcommerceStandardsDocuments
Assembly:  EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.3.0.0 (1.0.0.0)

The ESDRecordOrderPurchaseLine type exposes the following members.

Constructors
  NameDescription
Public methodESDRecordOrderPurchaseLine
Initializes a new instance of the ESDRecordOrderPurchaseLine class
Top
Properties
  NameDescription
Public propertyattributes
list of attributes associated with the line
Public propertydepth
Depth measurement of the product.
Public propertydepthUnitMeasureCode
Code of the product's depth measurement to define the unit of measurement.
Public propertydownloadCode
Code the download in the line.
Public propertydownloadDescription
description the download in the line.
Public propertydownloadName
name the download in the line.
Public propertydrop
Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed. Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored.
Public propertyentitySetPrice
Sets which system or person set the pricing of the line. Set it to a constant prefixed with ENTITY_SET_PRICE_ in the ESDocumentConstants class
Public propertyexternalKeyLocationID
key of the external location where the products for the order line can be found. This external location may be the location where goods are being delivered to or held at.
Public propertyexternalLocationCode
Code of the external location. This external location may be the location where goods are being delivered to or held at.
Public propertyexternalLocationName
Name of the external location. This external location may be the location where goods are being delivered to or held at.
Public propertyglAccountCode
Code of the general ledger account that the line is assigned to. The code can be used to identify the general ledger account that the purchase may be reported against for accounting purposes.
Public propertyglAccountName
Name of the general ledger account that the line is assigned to. The name can be used to identify the general ledger account that the purchase may be reported against for accounting purposes.
Public propertyheight
Height measurement of the product.
Public propertyheightUnitMeasureCode
Code of the product's height measurement to define the unit of measurement.
Public propertyinternalID
Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
Public propertyisKitted
Either
  • N - No
  • Y - Yes
If 'Y' then indicates that the line is associated to a product that is the parent of a kit.
Public propertyisPriceFree
Either
  • N - No
  • Y - Yes
If 'Y' then indicates that the price of the line was explicitly priced at 0.
Public propertyisReserved
Either
  • N - No
  • Y - Yes
If 'Y' then indicates quantity in the line should be reserved.
Public propertykeyDownloadID
Key of the download record associated to the line. Only relevent when the lineType has been set to download
Public propertykeyGLAccountID
Key of the general ledger account that the line is assigned to. This links the invoice line to the general ledger account that the purchase may be reported against for accounting purposes.
Public propertykeyLabourID
Key of the labour record associated to the line. Only relevent when the lineType has been set to labour
Public propertykeyLocationID
Key of the location record that the order line is assigned to.
Public propertykeyProductID
Key of the product record associated to the line. Only relevent when the lineType has been set to product
Public propertykeySellUnitID
Key of the sell unit that the line is assigned to.
Public propertykittedProductSetPrice
Either
  • N - No
  • Y - Yes
If 'Y' then indicates that the line has been priced based on the component product of a product kit.
Public propertylabourCode
Code the labour in the line.
Public propertylabourDescription
text to describe details of the labour in the line
Public propertylabourName
name the labour in the line.
Public propertylanguage
Language that the descriptive text of the line is set in. Set it to a constant prefixed with LANG_ in the ESDocumentConstants class
Public propertylineType
Type of line set in the order. Set it to a constant prefixed with ORDER_LINE_TYPE_ in the ESDocumentConstants class
Public propertylocationCode
Code of the location that order line is assigned to.
Public propertylocationName
Name of the location that the order line is assigned to.
Public propertypriceExTax
Monetary price of the line's unit, excluding tax.
Public propertypriceIncTax
Monetary price of the line's unit, including tax.
Public propertypriceReferenceCode
Code that the pricing references.
Public propertypriceReferenceType
Type of entity that the price is referenced to. Typically use one of the PRICE constants in th ESDRecordProductPrice class to set this field, or leave it empty.
Public propertypriceTax
Monetary price of the tax applied to the line's unit.
Public propertypriceTotalExTax
Total monetary price of the quantity of unit's ordered, excluding tax.
Public propertypriceTotalIncTax
Total monetary price of the quantity of unit's ordered, including tax.
Public propertypriceTotalTax
Total monetary price of the tax applied over the total quantity of unit's ordered.
Public propertypriceTotalUndiscountedExTax
Total monetary price of the quantity of unit's ordered before discounting, excluding tax.
Public propertypriceTotalUndiscountedIncTax
Total monetary price of the quantity of unit's ordered before discounting, including tax.
Public propertypriceTotalUndiscountedTax
Total monetary price of the tax applied over the total quantity of unit's ordered before discounting.
Public propertypriceUndiscountedExTax
Monetary price of the line's unit before any discounting was applied, exclusive of tax.
Public propertypriceUndiscountedIncTax
Monetary price of the line's unit before any discounting was applied, inclusive of tax.
Public propertypriceUndiscountedTax
Monetary price of tax applied the line's unit before any discounting was applied.
Public propertyproductCode
Code the product in the line.
Public propertyproductDeliveries
list of product delivery records for the order
Public propertyproductDescription
text to describe details of the product in the line
Public propertyproductName
name of the product in the line
Public propertyquantity
Quantity of units ordered.
Public propertysalesOrderDownloadCode
code of the download in the purchase order associated to the sales order
Public propertysalesOrderLabourCode
code of the labour in the purchase order associated to the sales order
Public propertysalesOrderLineCode
Code of the line in the sales order associated to the purchase order.
Public propertysalesOrderLineNumber
number of the line in the sales order associated to the purchase order.
Public propertysalesOrderProductCode
code of the product in the purchase order associated to the sales order
Public propertysellUnitBaseQuantity
Sets the unit quantity of the ordered line that makes up the base quantity. Eg. if the line was bought as a pack, this would indicate that a pack sell unit type consists of "6" individual units.
Public propertysupplierItemCode
Code of the supplier's product/labour/download that the line is associated to
Public propertytaxes
list of taxes applied to the line
Public propertytextDescription
description/comment or any other text to set for a line
Public propertyunitName
Name of the unit set for the line.
Public propertyUNSPSC
United Nations Standard Products and Service Code. Stores a standard code defined by the United Nations classifying objects.
Public propertyvolume
Volume measurement of the product.
Public propertyvolumeUnitMeasureCode
Code of the product's volume measurement to define the unit of measurement.
Public propertyweight
Weight measurement of the product.
Public propertyweightUnitMeasureCode
Code of the product's weight measurement to define the unit of measurement.
Public propertywidth
Width measurement of the product.
Public propertywidthUnitMeasureCode
Code of the product's width measurement to define the unit of measurement.
Top
Methods
  NameDescription
Public methodsetDefaultValuesForNullMembers
sets default values for members that have no values set
Top
See Also