Document_Lines Object Members
See Also Overview

Public Methods

Add	Adds a new data line to the object.
Delete	Deletes the current line. Returns a result value that indicates success or failure.
SetCurrentLine	Sets the active row to a specified row number.

Public Properties

AccountCode	Sets or returns the G/L account code of the business partner as defined in Chart of Accounts. Field name: AcctCode. Mandatory property. Length: 15 characters.
ActualBaseEntry	Sets or returns the actual source document ID. Field name: ActBaseEnt.
ActualBaseLine	Sets or returns the line number in the actual source document. Field name: ActBaseLn.
ActualDeliveryDate	Sets or returns the actual delivery date of the item specified in the row.
Address	Sets or returns the Bill To address of the business partner in purchase documents only. Field name: Address. Length: 254 characters.
AgreementNo	property AgreementNo
AgreementRowNumber	property AgreementRowNumber
AppliedTax	Returns the tax of a paid invoice in local currency. Field name: VatAppld.
AppliedTaxFC	Returns the tax of a paid invoice in foreign currency. Field name: VatAppldFC.
AppliedTaxSC	Returns the tax of a paid invoice in system currency. Field name: VatAppldSC.
BackOrder	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not to enable partial quantities of items per row in the document. Field name: BackOrdr.
BarCode	Sets or returns the Bar Code (EAN code) for this item. Field name: CodeBars. Length: 16 characters.
BaseEntry	Sets or returns the source Document ID. Field name: BaseEntry.
BaseLine	Sets or returns the line number in the source document. Field name: BaseLine.
BaseOpenQuantity	Returns the quantity in the base document at the time the user creates the target document. Field name: BaseOpnQty.
BaseType	Sets or returns a valid value of BoAPARDocumentTypes that determines the document type. Field name: BaseType.
BatchNumbers	Returns the BatchNumbers object.
BinAllocations	The bin allocation of items or serial items or batch items.
CCDNumbers	property CCDNumbers
CESTCode	Specify the CEST Code that identifies material items which are subject to ST taxation.. Field name: CESTCode.
CFOPCode	Sets or returns the CFOP Code for Document. This is a foreign key to the NotaFiscalCFOP object, which applicable for cluster B only (country-specific for Brazil only). Field name: CFOPCode. Length: 6 characters.
ChangeAssemlyBoMWarehouse	Sets or returns a value that specifies whether or not the default warehouse was changed for an item that is part of bill-of-material assembly. This is relevant for the specified item in the specified document only. Field name: ChgAsmBoMW. Length: 1 character.
ChangeInventoryQuantityIndependently	property ChangeInventoryQuantityIndependently
Cig	property Cig
CNJPOfManufacturer	CNPJ of manufacturer. Field name: CNJPMan. Length: 14 characters.
COGSAccountCode	Sets or returns the code of the Cost of Goods Sold account. This is a foreign key to the ChartOfAccounts object. Field name: CogsAcct. Length: 15 characters.
COGSCostingCode	Sets or returns the code of the Cost of Goods Sold cost center. This is a foreign key to the Loading Factors table (field name OcrCode in OOCR table). Field name: CogsOcrCod. Length: 8 characters.
COGSCostingCode2	Multiple cost centers assigned to the Cost of Goods Sold accounts. Field name: CogsOcrCod2. Length: 8 characters.
COGSCostingCode3	Multiple cost centers assigned to the Cost of Goods Sold accounts. Field name: CogsOcrCod3. Length: 8 characters.
COGSCostingCode4	Multiple cost centers assigned to the Cost of Goods Sold accounts. Field name: CogsOcrCod4. Length: 8 characters.
COGSCostingCode5	Multiple cost centers assigned to the Cost of Goods Sold accounts. Field name: CogsOcrCod5. Length: 8 characters.
CommisionPercent	Sets or returns the commission percentage for this item. Field name: Commission.
CommodityClassification	property CommodityClassification
ConsiderQuantity	property ConsiderQuantity
ConsumerSalesForecast	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not to include this line in the sales forecast. Field name: ConsumeFCT.
CorrectionInvoiceItem	Sets or returns a valid value of BoCorInvItemStatus type that specifies the status of the correction invoice. Field name: CEECFlag.
CorrInvAmountToDiffAcct	Sets or returns the amount of the correction invoice for the Difference Account. Field name: ToDiff.
CorrInvAmountToStock	Sets or returns the amount of the correction invoice for the Stock Account. Field name: ToStock.
CostingCode	The distribution rule for dimension 1 for allocating costs and revenues (both direct and indirect) to one or more profit centers. Field name: OcrCode This is a foreign key to the DistributionRule object.
CostingCode2	The distribution rule for dimension 2 for allocating costs and revenues (both direct and indirect) to one or more profit centers. Field name: OcrCode2.
CostingCode3	The distribution rule for dimension 3 for allocating costs and revenues (both direct and indirect) to one or more profit centers. Field name: OcrCode3.
CostingCode4	The distribution rule for dimension 4 for allocating costs and revenues (both direct and indirect) to one or more profit centers. Field name: OcrCode4.
CostingCode5	The distribution rule for dimension 5 for allocating costs and revenues (both direct and indirect) to one or more profit centers. Field name: OcrCode5.
Count	Returns the total number of records in the table.
CountryOrg	Sets or returns the origin country. Field name: CountryOrg. Length: 3 characters. This is a foreign key to the Countries table (OCRY - not exposed through the DI API).
CreditOriginCode	property CreditOriginCode
CSTCode	Sets or returns the CST Code for Document. This is a foreign key to the NotaFiscalCST object that enables to define CST codes for Nota Fiscal. The NotaFiscalCST object is for Brazil only. Field name: CSTCode. Length: 6 characters.
CSTforCBS	CST for CBS Code. The property is for Brazil only. Field name: CSTfCBS. Length: 2 characters.
CSTforCOFINS	CST for COFINS Code. The property is for Brazil only. Field name: CSTfCOFINS. Length: 2 characters.
CSTforIBS	CST for IBS Code. The property is for Brazil only. Field name: CSTfIBS. Length: 2 characters.
CSTforIPI	CST for IPI Code. The property is for Brazil only. Field name: CSTfIPI. Length: 2 characters.
CSTforIS	CST for IS Code. The property is for Brazil only. Field name: CSTfIS. Length: 2 characters.
CSTforPIS	CST for PIS Code. The property is for Brazil only. Field name: CSTfPIS. Length: 2 characters.
CtrSealQty	Specify Control Seal Quantity for document line. Field name: CtrSealQty.
Cup	Unique code of project. Field name: CUP.
Currency	Sets or returns the price currency used in the document row. Field name: Currency. Length: 3 characters.
CUSplit	If this flag is set to true, the amounts that are not subject to withholding tax and are not supplier income amounts are distinguished and split in a standalone report page. Field name: CUSplit.
DefectAndBreakup	property DefectAndBreakup
DeferredTax	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not to apply deferred tax for the item specified in the row. Field name: DeferrTax.
DestinationCountryForImport	property DestinationCountryForImport
DestinationRegionForImport	property DestinationRegionForImport
DiscountPercent	Sets or returns the discount percentage you specify for a customer, or the discount percentage a supplier specifies for you. Field name: Discount.
DistributeExpense	Determines whether or not to use Distribute Expense. Field name: DistribExp.
DocEntry	property DocEntry
EBooksDetails	property EBooksDetails
EnableReturnCost	property EnableReturnCost
EqualizationTaxPercent	Returns the equalization tax percentage for this item in the row. This equalization tax is an additional tax to the regular tax (NetTaxAmount property). Field name: EquVatPer.
ExciseAmount	Sets or returns the excise (tax) amount. Field name: ExciseAmt.
ExLineNo	Specify the ExLineNo field of the marketing document tables. The marketing document tables include INV1, RIN1, DLN1, RDN1, RDR1, QUT1, PCH1, RPC1, PDN1, RPD1, POR1, IGN1, IGE1, and DRF1. Length: 10 characters.
ExpenseOperationType	property ExpenseOperationType
Expenses	Returns the Document_LinesAdditionalExpenses child object.
ExpenseType	property ExpenseType
ExportProcesses	property ExportProcesses
ExternalCalcTaxAmount	property ExternalCalcTaxAmount
ExternalCalcTaxAmountFC	property ExternalCalcTaxAmountFC
ExternalCalcTaxAmountSC	property ExternalCalcTaxAmountSC
ExternalCalcTaxRate	property ExternalCalcTaxRate
Factor1	Sets or returns the value of the first factor for calculating the item's quantity in the row. Field name: Factor1.
Factor2	Sets or returns the value of the second factor for calculating the item's quantity in the row. Field name: Factor2.
Factor3	Sets or returns the value of the third factor for calculating the item's quantity in the row. Field name: Factor3.
Factor4	Sets or returns the value of the forth factor for calculating the item's quantity in the row. Field name: Factor4.
FederalTaxID	property FederalTaxID
FreeOfChargeBP	property FreeOfChargeBP
FreeText	Sets or returns comments related to the specified item in the row. Field name: FreeTxt. Length: 100 characters.
GeneratedAssets	property GeneratedAssets
GrossBase	Specifies how to retrieve the base price for calculating gross profit. The base price can be derived, for example, from the last purchase price, from a price list, or from the current item cost. Field name: GrossBase.
GrossBuyPrice	The cost for calculating the gross profit for each item in the current row. Field name: GrossBuyPr.
GrossPrice	property GrossPrice
GrossProfit	property GrossProfit
GrossProfitFC	property GrossProfitFC
GrossProfitSC	property GrossProfitSC
GrossProfitTotalBasePrice	The total cost for calculating the gross profit for the current row. This property is equal to the GrossBuyPrice property times the Quantity property. Field name: GPTtlBasPr.
GrossTotal	property GrossTotal
GrossTotalFC	property GrossTotalFC
GrossTotalSC	property GrossTotalSC
Height1	Sets or returns the primary height of the item specified in the row. Field name: Height1.
Height2	Sets or returns the secondary height of the item specified in the row. Field name: Height2.
Height2Unit	Sets or returns the measurement units for Height2 property. Field name: Hght2Unit.
Hight1Unit	Sets or returns the measurement units for Height1 property. Field name: Hght1Unit.
HSNEntry	property HSNEntry
ImportProcesses	property ImportProcesses
Incoterms	property Incoterms
IndicatorForRelevantScale	Indicator for relevant scale. Field name: IndEscala.
InventoryQuantity	The inventory quantity. Field name: InvQty.
ItemCode	Sets or returns the item code in the inventory. The item code must be unique. This is a foreign key to the Items object. Field name: ItemCode. Mandatory property. Length: 20 characters.
ItemDescription	Sets or returns the item name/description. Field name: Dscription. Length: 100 characters.
ItemDetails	Sets or returns the item details in the marketing document line. Field name: Text. Length: 16 characters.
ItemType	property ItemType
LastBuyDistributeSum	Returns the Last Buy Distribute Sum. Field name: LstByDsSum.
LastBuyDistributeSumFc	Returns the Last Buy Distribute Sum in Foreign Currency. Field name: LstByDsFc.
LastBuyDistributeSumSc	Returns the Last Buy Distribute Sum Sc in System Currency. Field name: LstByDsSc.
LastBuyInmPrice	Returns the last sales price of the item according to OIVL table (Warehouse Journal). Field name: LstBINMPr.
LegalText	Legal text. Field name: LegalText. Length: 254 characters.
Lengh1	Sets or returns the primary length of the item specified in the row. Field name: Length1.
Lengh1Unit	Sets or returns the measurement units for Lengh1 property. Field name: Len1Unit.
Lengh2	Sets or returns the secondary length of the item specified in the row. Field name: length2.
Lengh2Unit	Sets or returns the measurement units for Lengh2 property. Field name: Len2Unit.
LineNum	Returns the current row number in the list. Field name: LineNum.
LineStatus	Sets or returns a valid value that determines wether or not this document is open or close. Field name: LineStatus.
LineTotal	Returns the total amount (not including tax) per row. Field name: LineTotal.
LineType	Sets or returns a value specifying whether the line is a regular item line or an alternative item line.
LineVendor	property LineVendor
ListNum	property ListNum
LocationCode	Sets or returns the location code in invoices (INV1). Applicable for cluster B. Field name: LocCode.
MeasureUnit	The measurement unit (e.g., inch, cm). Field name: unitMsr. Length: 20 characters.
NatureOfTransaction	property NatureOfTransaction
NCMCode	property NCMCode
NetIncome	A financial measure that represents the total profit after all expenses have been subtracted from the total revenue. Net Income = Operating Profit – Total Amount of Taxes. This field is only available in the Brazil localization. Field name: NetIncome.
NetIncomeFC	Net income amount in foreign currency. This field is only available in the Brazil localization. Field name: NetIncomFC.
NetIncomeSC	Net income amount in system currency. This field is only available in the Brazil localization. Field name: NetIncomSy.
NetTaxAmount	Returns the standard tax amount (not including equalization tax) in local currency. Field name: LineVat.
NetTaxAmountFC	Returns the standard tax amount (not including equalization tax) in foreign currency. Field name: LineVatlF.
NetTaxAmountSC	Returns the standard tax amount (not including equalization tax) in system currency. Field name: LineVatS.
NVECode	Enter the NVE Code. Field name: NVECode. Length: 6 characters.
OpenAmount	The open amount for this line. Only relevant for service-type documents. The open amount is the original amount (from the LineTotal property) minus any amount received or credited. For example, in an A/R invoice, if the amount is $200 and then a credit memo is issued for $50, the open amount is $150. Field name: OpenSum.
OpenAmountFC	The open amount for this line in foreign currency. Only relevant for service-type documents. Field name: OpenSumFC.
OpenAmountSC	The open amount for this line in system currency. Only relevant for service-type documents. Field name: OpenSumSys.
OperatingProfit	A profitability measure that excludes operating expenses from the gross profit. Operating Profit = Gross Profit – Total Amount of Freight Costs. This field is only available in the Brazil localization. Field name: OperProfit.
OperatingProfitFC	Operating profit in foreign currency. This field is only available in the Brazil localization. Field name: OperProfFC.
OperatingProfitSC	Operating profit in system currency. This field is only available in the Brazil localization. Field name: OperProfSy.
OriginalItem	Returns the code of the item originally ordered, but due to lack in the stock it was replaced by its alternative item as defined in SAP Business One. Field name: OrigItem. Length: 20 characters. This is a foreign key to the Items object.
OriginCountryForExport	property OriginCountryForExport
OriginRegionForExport	property OriginRegionForExport
OwnerCode	property OwnerCode
PackageQuantity	Returns the number of lines in a package. Field name: PackQty.
ParentLineNum	property ParentLineNum
PartialRetirement	property PartialRetirement
PickListIdNumber	Returns the pick list ID number. Field name: PickIdNo.
PickLists	property PickLists
PickQuantity	Returns the item's quantity specified in the row. Field name: PickOty.
PickStatus	Returns a valid value of BoYesNoEnum type that specifies whether all quantity of the item specified in the row was picked or partially picked from the warehouse. Field name: PickStatus.
PickStatusEx	Returns a valid value of BoPickStatus enumeration type that specifies whether all quantity of the item specified in the row was picked or partially picked from the warehouse. Field name: PickStatus.
PlasticPackageExemptionReason	Official exemption reason from plastic packaging tax; options are determined by the authorities.
PoItemNum	Customer's purchase order item number. This number is relevant for all items and services. Field name: PoItmNum.
PoNum	Customer's purchase order number. This number is relevant for all items and services. Field name: PoNum. Length: 20 characters.
POTargetEntry	The internal ID of the PO target. Field name: PoTrgEntry.
POTargetNum	The PO target Number. Field name: PoTrgNum.
POTargetRowNum	The row number of the PO target. Field name: PoLineNum.
Price	Sets or returns the item price before taxation. Field name: Price.
PriceAfterVAT	Sets or returns the item price after taxation. Field name: PriceAfVAT.
ProjectCode	Sets or returns the project code related to the document. Field name: Project. Length: 8 characters. This is a foreign key to the OPRJ object.
Quantity	Sets or returns the quantity of items in the current business transaction. Field name: Quantity.
Rate	Sets or returns the exchange rate between the current currency used in this row and the local currency. Field name: Rate.
ReceiptNumber	property ReceiptNumber
RecognizedTaxCode	property RecognizedTaxCode
RemainingOpenInventoryQuantity	The remaining open inventory quantity. Field name: OpenInvQty.
RemainingOpenQuantity	The open quantity for this line. The open quantity is the original quantity (from the Quantity property) minus any quantity that has been delivered or credited. For example, in an A/P invoice, if the quantity is 10 and then a goods receipt is executed for the invoice for a quantity of 3, the open quantity is 7. Field name: OpenQty.
RequiredDate	The date by which the items should be delivered. Field: PQTReqDate.
RequiredQuantity	Number of the items to be procured. Field: PQTReqQty.
RetirementAPC	property RetirementAPC
RetirementQuantity	property RetirementQuantity
ReturnAction	property ReturnAction
ReturnCost	property ReturnCost
ReturnReason	property ReturnReason
ReverseCharge	Field: RevCharge.
RowTotalFC	Sets or returns the Row Total in foreign currency. Field name: TotalFrgn.
RowTotalSC	Sets or returns the Row Total in System currency. Field name: TotalSumSy.
SACEntry	property SACEntry
SalesPersonCode	Sets or returns the code of the sales employee who has created this document. Field name: SlpCode. This is a foreign key to the SalesPersons object.
SerialNum	Sets or returns the serial number of the document line. Field name: SerialNum. Length: 17 characters.
SerialNumbers	Returns the SerialNumbers object.
ShipDate	Sets or returns the row delivery date. Field name: ShipDate.
ShipFromCode	property ShipFromCode
ShipFromDescription	property ShipFromDescription
ShippingMethod	Sets or returns the code of the shipping type (such as, Courier or Air Cargo). Field name: ShipType. This is a foreign key to the ShippingTypes object.
ShipToCode	Returns the address Ship To Code. Field name: ShipToCode. Length: 50 characters.
ShipToDescription	property ShipToDescription
Shortages	property Shortages
StandardItemIdentification	property StandardItemIdentification
StgDesc	property StgDesc
StgEntry	property StgEntry
StgSeqNum	property StgSeqNum
StockDistributesum	Returns the Stock Distribute sum. Field name: StckDstSum.
StockDistributesumForeign	Returns the Stock Distribute sum in Foreign currency. Field name: StckDstFc.
StockDistributesumSystem	Returns the Stock Distribute sum in System currency. Field name: StckDstSc.
StockInmPrice	Returns the Stock's last sale price according to the INM table. Field name: StckINMPr.
SupplierCatNum	Sets or returns the Vendor Catalog No. Field name: SubCatNum. Length: 14 characters.
Surpluses	property Surpluses
SWW	Sets or returns an additional identifier of the item in the line. Field name: SWW. Length: 16 characters.
TaxBeforeDPM	Returns the total tax amount, in local currency, before down payments are applied. Field name: VatWoDpm.
TaxBeforeDPMFC	Returns the total tax amount, in foreign currency, before down payments are applied. Field name: VatWoDpmFc.
TaxBeforeDPMSC	Returns the total tax amount, in System currency, before down payments are applied. Field name: VatWoDpmSc.
TaxCode	Sets or returns the sales tax code for the item specified in the row. Field name: TaxCode. Length: 8 characters. This is a foreign key to the SalesTaxCodes object.
TaxJurisdictions	Returns the TaxJurisdictions object.
TaxLiable	Sets or returns a valid value that specifies whether or not the item is VAT liable. Field name: WtLiable.
TaxOnly	Sets or returns a valid value that Determines whether or not the item is marked as Tax Only. Field name: TaxOnly. The object is applicable for cluster B only (country-specific for Brazil only).
TaxPercentagePerRow	Sets or returns the tax percentage per row. Field name: VatPrcnt.
TaxPerUnit	Returns the tax per unit. Field name: TaxPerUnit.
TaxTotal	The total tax amount. The application calculates the tax amount as follows: TaxTotal = NetTaxAmount + TotalEqualizationTax. You can manually adjust the tax amount according to the business need. Field name: VatSum.
TaxType	Sets or returns a valid value of BoTaxTypes type that specifies the sales tax system for the item. Field name: VatSum.
Text	Returns the text property. Field name: text.
ThirdParty	property ThirdParty
TotalEqualizationTax	Returns the equalization tax amount in local currency. Field name: EquVatSum.
TotalEqualizationTaxFC	Returns the equalization tax amount in foreign currency. Field name: EquVatSumF.
TotalEqualizationTaxSC	Returns the equalization tax amount in system currency. Field name: EquVatSumS.
TotalInclTax	Returns the total amount including tax. Field name: TotInclTax.
TransactionType	Sets or returns a valid value of the Transaction Type. Field name: TranType.
TransportMode	property TransportMode
TreeType	Returns a valid value of BoItemTreeTypes type that specifies the product tree type of the item (also known as bill of material type). Field name: TreeType.
UFFiscalBenefitCode	Enter the UF Fiscal Benefit Code. This code is relevant for all items and services.. Field name: UFFiscBene. Length: 10 characters.
UnencumberedReason	Choose the Reason for Unencumbered ICMS Exemption. The unencumbered ICMS exemption reason is defined based on the specific CST for ICMS suffix. Field name: UnencReasn.
UnitPrice	Sets or returns this tax invoice raw unit price. Field name: UnitPrice.
UnitsOfMeasurment	The number of items per measurement unit. The measurement unit is defined in the MeasureUnit property. Field name: NumPerMsr.
UoMCode	The unique code for the UoM. Field name: UomCode. Length: 20 characters.
UoMEntry	The internal key of the UoM. Field name: UomEntry.
Usage	Sets or returns the Usage Code for Document. Field name: Usage. This is a foreign key to the NotaFiscalUsage object. The object is applicable for cluster B only (country-specific for Brazil only).
UseBaseUnits	Indicates whether to use the base units as defined in SAP Business One. Field name: UseBaseUn.
UserFields	Returns the UserFields object.
VatGroup	Sets or returns the VAT group for the item specified in the row. Field name: VatGroup. Length: 8 characters.
VendorNum	Sets or returns the number of the vendor who supplied this item. Field name: VendorNum. Length: 17 characters.
VisualOrder	Returns the visual order number. The value for the first row is null, and from the second row the number starts from 1. Field name: VisOrder.
Volume	Sets or returns the item volume. Field name: Volume.
VolumeUnit	Sets or returns the calculation unit for Volume (ci, cc, cmm, and so on). Field name: VolUnit.
WarehouseCode	Sets or returns the warehouse code where the item is stored. Field name: WhsCode. Length: 8 characters.
Weight1	Sets or returns the primary weight of the item specified in the row. Field name: Weight1.
Weight1Unit	Sets or returns the measurement units for Weight1 property. Field name: Wght1Unit.
Weight2	Sets or returns the secondary weight of the item specified in the row. Field name: Weight2.
Weight2Unit	Sets or returns the measurement units for Weight2 property. Field name: Wght2Unit.
WeightOfRecycledPlastic	Total weight of recycled plastic for row of marketing document.
Width1	Sets or returns the primary width of the item specified in the row. Field name: Width1.
Width1Unit	Sets or returns the measurement units for Width1 property. Field name: Wdth1Unit.
Width2	Sets or returns the secondary width of the item specified in the row. Field name: Width2.
Width2Unit	Sets or returns the measurement units for Width2 property. Field name: Wdth2Unit.
WithholdingTaxLines	Returns the WithholdingTaxLines object which support withholding tax on line level (as opposed to WithholdingTaxData object, which supports Withholding Tax in a document level). The object is applicable for cluster B only (country-specific for Brazil only).
WithoutInventoryMovement	To indicate that there is no inventory movement involved, that is, the credit memo does not affect the inventory quantity of the item. In this case, only the inventory value of the item is adjusted, if the quantity is positive. Field name: NoInvtryMv.
WTLiable	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not this item is subject to Withholding tax. Field name: WtLiable.

Public Methods

Public Properties

See Also