salesOrderLine resource type

Represents a sales order line in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET salesOrderLinesalesOrderLineGets a sales order line object.
DELETE salesOrderLinenoneDeletes a sales order line object.
POST salesOrderLinesalesOrderLineCreates a sales order line object.
PATCH salesOrderLinesalesOrderLineUpdates a sales order line object.
NavigationReturn TypeDescription
salesOrdersalesOrderGets the salesorder of the salesOrderLine.
itemitemGets the item of the salesOrderLine.
accountaccountGets the account of the salesOrderLine.
unitOfMeasureunitOfMeasureGets the unitofmeasure of the salesOrderLine.
itemVariantitemVariantGets the itemvariant of the salesOrderLine.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the salesOrderLine.
locationlocationGets the location of the salesOrderLine.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sales order line. Non-editable.
documentIdGUIDThe ID of the parent sales order line.
sequenceintegerThe line sequence number.
itemIdGUIDThe ID of the item in the sales order line.
accountIdGUIDThe id of the account that the sales order line is related to.
lineTypeNAV.invoiceLineAggLineTypeThe type of the sales order line. It can be "Comment", "Account", "Item", "Resource" Value", "Fixed Asset" or "Charge".
lineObjectNumberstringThe number of the object (account or item) of the sales order line.
descriptionstringSpecifies the description of the sales order line.
description2string
unitOfMeasureIdGUIDThe ID of unit of measure for the sales order line.
unitOfMeasureCodestringThe code of unit of measure for the sales order line.
quantitydecimalThe quantity of the item in the sales order line.
unitPricedecimalSpecifies the price for one unit of the item in the specified sales order line.
discountAmountdecimalThe sales order line discount amount.
discountPercentdecimalThe line discount percent.
discountAppliedBeforeTaxbooleanSpecifies whether the discount is applied before tax.
amountExcludingTaxdecimalThe line amount excluding the tax. Read-Only.
taxCodestringThe tax code for the line.
taxPercentdecimalThe tax percent for the line. Read-Only.
totalTaxAmountdecimalThe total tax amount for the sales order line. Read-Only.
amountIncludingTaxdecimalThe total amount for the line including tax. Read-Only.
invoiceDiscountAllocationdecimalThe sales order line discount allocation is the sales order line discount distributed on the total amount. Read-Only.
netAmountdecimalThe net amount is the amount including all discounts (taken from the sales order line). Read-Only.
netTaxAmountdecimalThe net tax amount is the tax amount calculated from net amount. Read-Only.
netAmountIncludingTaxdecimalThe net amount including tax is the total net amount including tax. Read-Only.
shipmentDatedateThe date the item in the line is expected to ship.
shippedQuantitydecimalThe quantity of items from the order already shipped.
invoicedQuantitydecimalThe quantity of items from the sales order line that was invoiced.
invoiceQuantitydecimalThe quantity of items from the sales order line to be invoiced.
shipQuantitydecimalThe quantity of items from the order to be shipped.
itemVariantIdGUIDThe ID of the item variant in the sales order line.
locationIdGUID

JSON representation

Here's a JSON representation of the salesOrderLine resource.

{
    "id": "GUID",
    "documentId": "GUID",
    "sequence": "integer",
    "itemId": "GUID",
    "accountId": "GUID",
    "lineType": "NAV.invoiceLineAggLineType",
    "lineObjectNumber": "string",
    "description": "string",
    "description2": "string",
    "unitOfMeasureId": "GUID",
    "unitOfMeasureCode": "string",
    "quantity": "decimal",
    "unitPrice": "decimal",
    "discountAmount": "decimal",
    "discountPercent": "decimal",
    "discountAppliedBeforeTax": "boolean",
    "amountExcludingTax": "decimal",
    "taxCode": "string",
    "taxPercent": "decimal",
    "totalTaxAmount": "decimal",
    "amountIncludingTax": "decimal",
    "invoiceDiscountAllocation": "decimal",
    "netAmount": "decimal",
    "netTaxAmount": "decimal",
    "netAmountIncludingTax": "decimal",
    "shipmentDate": "date",
    "shippedQuantity": "decimal",
    "invoicedQuantity": "decimal",
    "invoiceQuantity": "decimal",
    "shipQuantity": "decimal",
    "itemVariantId": "GUID",
    "locationId": "GUID"
}

GET salesOrderLine
DELETE salesOrderLine
POST salesOrderLine
PATCH salesOrderLine