purchaseInvoices resource type (v1.0)

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

Represents a purchase invoice 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 purchaseInvoicespurchaseInvoicesGets a purchase invoice object.
POST purchaseInvoicespurchaseInvoicesCreates a purchase invoice object.
PATCH purchaseInvoicespurchaseInvoicesUpdates a purchase invoice object.
DELETE purchaseInvoicesnoneDeletes a purchase invoice object.

Bound actions

ActionReturn typeDescription
GET pdfDocumentpdfDocumentGets a PDF document.

Properties

PropertyTypeDescription
idGUIDThe invoice ID. Read-Only.
numberstring, maximum size 20The invoice number. Read-Only.
invoiceDatedateThe invoice date
dueDatedateThe date the invoice is due.
vendorInvoiceNumberstring, maximum size 35The vendor sales order reference for the invoice
vendorIdGUIDThe id of the invoice vendor.
vendorNumberstring, maximum size 20The vendor number for the invoice.
vendorNamestring, maximum size 50The full name of the vendor. Read-Only.
buyFromAddressNAV.PostalAddressThe vendor's address.
currencyIdGUIDThe currency Id for the invoice.
currencyCodestring, maximum size 10The currency code for the invoice.
statusstring, maximum size 20The invoice status. Status can be: Draft, In Review, Open, Paid, Canceled, or Corrective. Read-Only.
discountAmountnumericThe invoice discount amount
discountAppliedBeforeTaxbooleanSpecifies whether the discount is applied before tax.
totalAmountExcludingTaxnumericThe total amount excluding tax. Read-Only.
totalTaxAmountnumericThe total tax amount for the invoice. Read-Only.
totalAmountIncludingTaxnumericThe total amount for the invoice, including tax. Read-Only.
pricesIncludeTaxbooleanSpecifies whether the prices include Tax or not. Read-Only.
paymentTermsstring, maximum size 10The payment terms of the invoice.
shipmentMethodstring, maximum size 10The shipment method of the invoice.
payToNamestring, maximum size 100Pay to name of the invoice.
payToContactstring, maximum size 100Pay to contact
payToVendorIdGUIDPay to vendor id.
payToVendorNumberstring, maximum size 20Pay to vendor number
shipToNamestring, maximum size 100Ship to name.
shipToContactstring, maximum size 100Ship to contact.
buyFromAddressNAV.postalAddressTypeBuy from address.
payToAddressNAV.postalAddressTypePay to address.
shipToAddressNAV.postalAddressTypeShip to address.
lastModifiedDateTimedatetimeThe 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"
}

Purchase Invoice
Get Purchase Invoice
Create Purchase Invoice
Update Purchase Invoice
Delete Purchase Invoice