vendors 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 vendor 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 vendorsvendorsGets a vendor object.
POST vendorsvendorsCreates a vendor object.
PATCH vendorsvendorsUpdates a vendor object.
DELETE vendornoneDeletes a vendor object.
Go toTypeDescription
PicturepictureGets the picture of vendor.
defaultDimensionsdefaultDimensionGets the defaultDimension of vendor.
currencycurrencyGets the currency of vendor.
paymentTermpaymentTermGets the paymentTerm of vendor.
paymentMethodpaymentMethodGets the paymentMethod of vendor.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the vendor. Non-editable.
numberstringThe vendor number.
displayNamestringThe vendor's display name.
addressNAV.PostalAddressThe vendor's address.
phoneNumberstringThe vendor's telephone number.
emailstringThe vendor's email address.
websitestringThe vendor's website address.
taxRegistrationNumberstringThe vendor's tax registration number.
currencyIdGUIDThe default currency code ID for the vendor.
currencyCodestringThe default currency code for the vendor.
irs1099CodestringSpecifies a 1099 code for the vendor. US only.
paymentTermsIdGUIDThe default payment terms ID for the vendor.
paymentMethodIdGUIDThe default payment method ID for the vendor.
taxLiablebooleanSpecifies if the vendor is liable for tax.
blockedstringSpecifies which transactions with the vendor that cannot be posted. Accepted values are blank, Payment or All
balancedecimalThe vendor's balance. Read-Only.
lastModifiedDateTimedatetimeThe last datetime the vendor was modified. Read-Only.

Relationships

Picture, defaultDimension, currency, paymentTerm, paymentMethod

JSON representation

Here is a JSON representation of the vendor.

{
  "id": "GUID",
  "number": "string",
  "displayName": "string",
  "address": "NAV.PostalAddress",
  "phoneNumber": "string",
  "email": "string",
  "website": "string",
  "taxRegistrationNumber": "string",
  "currencyId": "GUID",
  "currencyCode": "string",
  "irs1099Code": "string",
  "paymentTermsId": "GUID",
  "paymentMethodId": "GUID",
  "paymentMethod": "NAV.PaymentMethod",
  "taxLiable": "boolean",
  "blocked": "string",
  "balance": "decimal",
  "lastModifiedDateTime": "datetime"
}

Get Vendor
Create Vendor
Update Vendor
Delete Vendor