purchaseInvoiceLine resource type

Represents a purchase invoice 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 purchaseInvoiceLinepurchaseInvoiceLineGets a purchase invoice line object.
DELETE purchaseInvoiceLinenoneDeletes a purchase invoice line object.
POST purchaseInvoiceLinepurchaseInvoiceLineCreates a purchase invoice line object.
PATCH purchaseInvoiceLinepurchaseInvoiceLineUpdates a purchase invoice line object.
NavigationReturn TypeDescription
purchaseInvoicepurchaseInvoiceGets the purchaseinvoice of the purchaseInvoiceLine.
itemitemGets the item of the purchaseInvoiceLine.
accountaccountGets the account of the purchaseInvoiceLine.
unitOfMeasureunitOfMeasureGets the unitofmeasure of the purchaseInvoiceLine.
itemVariantitemVariantGets the itemvariant of the purchaseInvoiceLine.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the purchaseInvoiceLine.
locationlocationGets the location of the purchaseInvoiceLine.

Properties

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

JSON representation

Here's a JSON representation of the purchaseInvoiceLine resource, showing the full shape of the resources that a GET would return.

{
    "id": "GUID",
    "documentId": "GUID",
    "sequence": "integer",
    "itemId": "GUID",
    "accountId": "GUID",
    "lineType": "NAV.invoiceLineAggLineType",
    "lineObjectNumber": "string",
    "description": "string",
    "description2": "string",
    "unitOfMeasureId": "GUID",
    "unitOfMeasureCode": "string",
    "unitCost": "decimal",
    "quantity": "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",
    "itemVariantId": "GUID",
    "locationId": "GUID"
}

GET purchaseInvoiceLine
DELETE purchaseInvoiceLine
POST purchaseInvoiceLine
PATCH purchaseInvoiceLine