vendor resource type

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 vendorvendorGets a vendor object.
DELETE vendornoneDeletes a vendor object.
POST vendorvendorCreates a vendor object.
PATCH vendorvendorUpdates a vendor object.
NavigationReturn TypeDescription
currencycurrencyGets the currency of the vendor.
paymentTermpaymentTermGets the paymentterm of the vendor.
paymentMethodpaymentMethodGets the paymentmethod of the vendor.
picturepictureGets the picture of the vendor.
defaultDimensionsdefaultDimensionsGets the defaultdimensions of the vendor.
agedAccountsPayableagedAccountsPayableGets the agedaccountspayable of the vendor.
contactsInformationcontactsInformationGets the contactsinformation of the vendor.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the vendor.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the vendor. Non-editable.
numberstringSpecifies the number of the vendor.
displayNamestringSpecifies the vendor's name. This name will appear on all sales documents for the vendor.
addressLine1stringSpecifies the vendor's address. This address will appear on all sales documents for the vendor.
addressLine2stringSpecifies the vendor's address. This address will appear on all sales documents for the vendor.
citystringSpecifies the vendor's city.
statestringSpecifies the vendor's state.
countrystringSpecifies the vendor's country.
postalCodestringSpecifies the vendor's postal code.
phoneNumberstringSpecifies the vendor's telephone number.
emailstringSpecifies the vendor's email address.
websitestringSpecifies the vendor's home page address.
taxRegistrationNumberstringSpecified the tax registration number of the vendor.
currencyIdGUIDSpecifies which currency the vendor uses.
currencyCodestringThe default currency code for the vendor.
irs1099CodestringSpecifies a 1099 code for the vendor. US only.
paymentTermsIdGUIDSpecifies which payment term the vendor uses.
paymentMethodIdGUIDSpecifies which payment method the vendor uses.
taxLiablebooleanSpecifies if the vendor or vendor is liable for sales tax. Set to true if the vendor is tax liable.
blockedNAV.vendorBlockedSpecifies which transactions with the customer can't be posted. It can be <Member Name=" ", "Payment" or "All".
balancedecimalSpecifies vendor's total balance.
lastModifiedDateTimedatetimeThe last datetime the vendor was modified. Read-Only.

JSON representation

Here's a JSON representation of the vendor resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "website": "string",
    "taxRegistrationNumber": "string",
    "currencyId": "GUID",
    "currencyCode": "string",
    "irs1099Code": "string",
    "paymentTermsId": "GUID",
    "paymentMethodId": "GUID",
    "taxLiable": "boolean",
    "blocked": "NAV.vendorBlocked",
    "balance": "decimal",
    "lastModifiedDateTime": "datetime"
}

GET vendor
DELETE vendor
POST vendor
PATCH vendor