salesOrderLine resource type

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Represents a sales order line in Dynamics 365 Business Central.

Note

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

Methods

Method Return Type Description
GET salesOrderLine salesOrderLine Gets a sales order line object.
DELETE salesOrderLine none Deletes a sales order line object.
POST salesOrderLine salesOrderLine Creates a sales order line object.
PATCH salesOrderLine salesOrderLine Updates a sales order line object.
Navigation Return Type Description
salesOrder salesOrder Gets the salesorder of the salesOrderLine.
item item Gets the item of the salesOrderLine.
account account Gets the account of the salesOrderLine.
unitOfMeasure unitOfMeasure Gets the unitofmeasure of the salesOrderLine.
itemVariant itemVariant Gets the itemvariant of the salesOrderLine.
dimensionSetLines dimensionSetLines Gets the dimensionsetlines of the salesOrderLine.

Properties

Property Type Description
id GUID The unique ID of the sales order line. Non-editable.
documentId GUID The ID of the parent sales order line.
sequence integer The line sequence number.
itemId GUID The ID of the item in the sales order line.
accountId GUID The id of the account that the sales order line is related to.
lineType NAV.invoiceLineAggLineType The type of the sales order line. It can be "Comment", "Account", "Item", "Resource" Value", "Fixed Asset" or "Charge".
lineObjectNumber string The number of the object (account or item) of the sales order line.
description string Specifies the description of the sales order line.
unitOfMeasureId GUID The ID of unit of measure for the sales order line.
unitOfMeasureCode string The code of unit of measure for the sales order line.
quantity decimal The quantity of the item in the sales order line.
unitPrice decimal Specifies the price for one unit of the item in the specified sales order line.
discountAmount decimal The sales order line discount amount.
discountPercent decimal The line discount percent.
discountAppliedBeforeTax boolean Specifies whether the discount is applied before tax.
amountExcludingTax decimal The line amount excluding the tax. Read-Only.
taxCode string The tax code for the line.
taxPercent decimal The tax percent for the line. Read-Only.
totalTaxAmount decimal The total tax amount for the sales order line. Read-Only.
amountIncludingTax decimal The total amount for the line including tax. Read-Only.
invoiceDiscountAllocation decimal The sales order line discount allocation is the sales order line discount distributed on the total amount. Read-Only.
netAmount decimal The net amount is the amount including all discounts (taken from the sales order line). Read-Only.
netTaxAmount decimal The net tax amount is the tax amount calculated from net amount. Read-Only.
netAmountIncludingTax decimal The net amount including tax is the total net amount including tax. Read-Only.
shipmentDate date The date the item in the line is expected to ship.
shippedQuantity decimal The quantity of items from the order already shipped.
invoicedQuantity decimal The quantity of items from the sales order line that was invoiced.
invoiceQuantity decimal The quantity of items from the sales order line to be invoiced.
shipQuantity decimal The quantity of items from the order to be shipped.
itemVariantId GUID The ID of the item variant in the sales order line.

JSON representation

Here is a JSON representation of the salesOrderLine resource.

{
    "id": "GUID",
    "documentId": "GUID",
    "sequence": "integer",
    "itemId": "GUID",
    "accountId": "GUID",
    "lineType": "NAV.invoiceLineAggLineType",
    "lineObjectNumber": "string",
    "description": "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"
}

See Also

GET salesOrderLine DELETE salesOrderLine POST salesOrderLine PATCH salesOrderLine