purchaseInvoiceLine 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 purchase invoice 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 purchaseInvoiceLine purchaseInvoiceLine Gets a purchase invoice line object.
DELETE purchaseInvoiceLine none Deletes a purchase invoice line object.
POST purchaseInvoiceLine purchaseInvoiceLine Creates a purchase invoice line object.
PATCH purchaseInvoiceLine purchaseInvoiceLine Updates a purchase invoice line object.
Navigation Return Type Description
purchaseInvoice purchaseInvoice Gets the purchaseinvoice of the purchaseInvoiceLine.
item item Gets the item of the purchaseInvoiceLine.
account account Gets the account of the purchaseInvoiceLine.
unitOfMeasure unitOfMeasure Gets the unitofmeasure of the purchaseInvoiceLine.
itemVariant itemVariant Gets the itemvariant of the purchaseInvoiceLine.
dimensionSetLines dimensionSetLines Gets the dimensionsetlines of the purchaseInvoiceLine.

Properties

Property Type Description
id GUID The unique ID of the purchase invoice line. Non-editable.
documentId GUID The ID of the parent purchase invoice line.
sequence integer The line sequence number.
itemId GUID The ID of the item in the purchase invoice line.
accountId GUID The id of the account that the purchase invoice line is related to.
lineType NAV.invoiceLineAggLineType The type of the purchase invoice 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 purchase invoice line.
description string Specifies the description of the purchase invoice line.
unitOfMeasureId GUID The ID of unit of measure for the purchase invoice line.
unitOfMeasureCode string The code of unit of measure for the purchase invoice line.
unitCost decimal The unit cost of each individual item in the purchase invoice line.
quantity decimal The quantity of the item in the purchase invoice line.
discountAmount decimal The purchase invoice 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 purchase invoice line. Read-Only.
amountIncludingTax decimal The total amount for the line including tax. Read-Only.
invoiceDiscountAllocation decimal The purchase invoice line discount allocation is the purchase invoice line discount distributed on the total amount. Read-Only.
netAmount decimal The net amount is the amount including all discounts (taken from the purchase invoice 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.
expectedReceiptDate date The date the item in the line is expected to be received.
itemVariantId GUID The ID of the item variant in the purchase invoice line.

JSON representation

Here is a JSON representation of the purchaseInvoiceLine resource.

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

See Also

GET purchaseInvoiceLine DELETE purchaseInvoiceLine POST purchaseInvoiceLine PATCH purchaseInvoiceLine