purchaseOrderLine resource type

Represents a purchase 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 purchaseOrderLinepurchaseOrderLineGets a purchase order line object.
DELETE purchaseOrderLinenoneDeletes a purchase order line object.
POST purchaseOrderLinepurchaseOrderLineCreates a purchase order line object.
PATCH purchaseOrderLinepurchaseOrderLineUpdates a purchase order line object.
NavigationReturn TypeDescription
purchaseOrderpurchaseOrderGets the purchaseorder of the purchaseOrderLine.
itemitemGets the item of the purchaseOrderLine.
accountaccountGets the account of the purchaseOrderLine.
unitOfMeasureunitOfMeasureGets the unitofmeasure of the purchaseOrderLine.
itemVariantitemVariantGets the itemvariant of the purchaseOrderLine.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the purchaseOrderLine.
locationlocationGets the location of the purchaseOrderLine.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the purchase order line. Non-editable.
documentIdGUIDThe ID of the parent purchase order line.
sequenceintegerThe line sequence number.
itemIdGUIDThe ID of the item in the purchase order line.
accountIdGUIDThe id of the account that the purchase order line is related to.
lineTypeNAV.invoiceLineAggLineTypeThe type of the purchase order line. It can be "Comment", "Account", "Item", "Resource" Value", "Fixed Asset" or "Charge".
lineObjectNumberstringThe number of the object (account or item) of the purchase order line.
descriptionstringSpecifies the description of the purchase order line.
description2string
unitOfMeasureIdGUIDThe ID of unit of measure for the purchase order line.
unitOfMeasureCodestringThe code of unit of measure for the purchase order line.
quantitydecimalThe quantity of the item in the purchase order line.
directUnitCostdecimalThe direct cost per unit.
discountAmountdecimalThe purchase 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 purchase order line. Read-Only.
amountIncludingTaxdecimalThe total amount for the line including tax. Read-Only.
invoiceDiscountAllocationdecimalThe purchase order line discount allocation is the purchase order line discount distributed on the total amount. Read-Only.
netAmountdecimalThe net amount is the amount including all discounts (taken from the purchase 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.
expectedReceiptDatedateThe date the item in the line is expected to be received.
receivedQuantitydecimalThe quantity of items from the purchase order line that was received.
invoicedQuantitydecimalThe quantity of items from the purchase order line that was invoiced.
invoiceQuantitydecimalThe quantity of items from the purchase order line to be invoiced.
receiveQuantitydecimalThe quantity of items from the purchase order line to be received.
itemVariantIdGUIDThe ID of the item variant in the purchase order line.
locationIdGUID

JSON representation

Here's a JSON representation of the purchaseOrderLine 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",
    "directUnitCost": "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",
    "expectedReceiptDate": "date",
    "receivedQuantity": "decimal",
    "invoicedQuantity": "decimal",
    "invoiceQuantity": "decimal",
    "receiveQuantity": "decimal",
    "itemVariantId": "GUID",
    "locationId": "GUID"
}

GET purchaseOrderLine
DELETE purchaseOrderLine
POST purchaseOrderLine
PATCH purchaseOrderLine