purchaseInvoices resource type

Article
03/19/2018

Represents a purchase invoice 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 purchaseInvoices	purchaseInvoices	Gets a purchase invoice object.
POST purchaseInvoices	purchaseInvoices	Creates a purchase invoice object.
PATCH purchaseInvoices	purchaseInvoices	Updates a purchase invoice object.
DELETE purchaseInvoices	none	Deletes a purchase invoice object.

Bound actions

Action	Return type	Description
GET pdfDocument	pdfDocument	Gets a PDF document.

Properties

Property	Type	Description
id	GUID	The invoice ID. Read-Only.
number	string, maximum size 20	The invoice number. Read-Only.
invoiceDate	date	The invoice date
dueDate	date	The date the invoice is due.
vendorInvoiceNumber	string, maximum size 35	The vendor sales order reference for the invoice
vendorId	GUID	The id of the invoice vendor.
vendorNumber	string, maximum size 20	The vendor number for the invoice.
vendorName	string, maximum size 50	The full name of the vendor. Read-Only.
buyFromAddress	NAV.PostalAddress	The vendor's address.
currencyCode	string, maximum size 10	The currency code for the invoice.
status	string, maximum size 20	The invoice status. Status can be: Draft, In Review, Open, Paid, Canceled, or Corrective. Read-Only.
discountAmount	numeric	The invoice discount amount
discountAppliedBeforeTax	boolean	Specifies whether the discount is applied before tax.
totalAmountExcludingTax	numeric	The total amount excluding tax. Read-Only.
totalTaxAmount	numeric	The total tax amount for the invoice. Read-Only.
totalAmountIncludingTax	numeric	The total amount for the invoice, including tax. Read-Only.
pricesIncludeTax	boolean	Specifies whether the prices include Tax or not. Read-Only.
paymentTerms	string, maximum size 10	The payment terms of the invoice.
shipmentMethod	string, maximum size 10	The shipment method of the invoice.
lastModifiedDateTime	datetime	The last datetime the purchase invoice was modified. Read-Only.

Relationships

A Currency (currencyCode) must exist in the Currencies table.

A Payment Term (paymentTerms) must exist in the Payment Terms table.

A Shipment Method (shipmentMethod) must exist in the Shipment Method table.

A Vendor (vendorId) must exist in the Vendor table.

JSON representation

Here is a JSON representation of the resource.

{
      "id": "GUID",
      "number": "string",
      "invoiceDate": "Date",
      "dueDate": "Date",
      "vendorInvoiceNumber": "string",
      "vendorId": "GUID",
      "vendorNumber": "string",
      "vendorName": "string",
      "currencyCode": "string",
      "status": "string",
      "discountAmount": "decimal",
      "discountAppliedBeforeTax": "boolean",
      "totalAmountExcludingTax": "decimal",
      "pricesIncludeTax": "boolean",
      "totalTaxAmount": "decimal",
      "totalAmountIncludingTax": "decimal",
      "buyFromAddress": {NAV.PostalAddress},
      "paymentTermsId": "GUID",
      "shipmentMethod": "string",
      "lastModifiedDateTime": "DateTime"
}