vendor resource type (Beta)

Important

The finance reports API is announced as deprecated starting with Business Central 2026 release wave 2 and will be removed in Business Central 2027 release wave 1. We recommend that you transition to the Analytics API instead. Learn more in Analytics API overview.

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

Method	Return Type	Description
GET vendor	vendor	Gets a vendor object.

Properties

Property	Type	Description
id	GUID	The unique ID of the vendor. Non-editable.
number	string	Specifies the number of the vendor.
displayName	string	Specifies the vendor's name. This name will appear on all sales documents for the vendor.
city	string	Specifies the vendor's city.
state	string	Specifies the vendor's state.
country	string	Specifies the vendor's country.
postalCode	string	Specifies the vendor's postal code.
currencyCode	string	The default currency code for the vendor.
paymentTermsId	GUID	Specifies which payment term the vendor uses.
paymentMethodId	GUID	Specifies which payment method the vendor uses.
taxLiable	boolean	Specifies if the vendor or vendor is liable for sales tax. Set to true if the vendor is tax liable.
blocked	string	Specifies that transactions with the vendor cannot be posted. Set to All, if the vendor is blocked, set to blank if not blocked.
balance	decimal	Specifies vendor's total balance.
lastModifiedDateTime	datetime	The last datetime the vendor was modified. Read-Only.

JSON representation

Here is a JSON representation of the vendor resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "currencyCode": "string",
    "paymentTermsId": "GUID",
    "paymentMethodId": "GUID",
    "taxLiable": "boolean",
    "blocked": "string",
    "balance": "decimal",
    "lastModifiedDateTime": "datetime"
}

Related information

GET vendor