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. |
| DELETE vendor | none | Deletes a vendor object. |
| POST vendor | vendor | Creates a vendor object. |
| PATCH vendor | vendor | Updates a vendor object. |
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| currency | currency | Gets the currency of the vendor. |
| paymentTerm | paymentTerm | Gets the paymentterm of the vendor. |
| paymentMethod | paymentMethod | Gets the paymentmethod of the vendor. |
| picture | picture | Gets the picture of the vendor. |
| defaultDimensions | defaultDimensions | Gets the defaultdimensions of the vendor. |
| agedAccountsPayable | agedAccountsPayable | Gets the agedaccountspayable of the vendor. |
| contactsInformation | contactsInformation | Gets the contactsinformation of the vendor. |
| documentAttachments | documentAttachments | Gets the documentattachments of the vendor. |
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. |
| addressLine1 | string | Specifies the vendor's address. This address will appear on all sales documents for the vendor. |
| addressLine2 | string | Specifies the vendor's address. This address 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. |
| phoneNumber | string | Specifies the vendor's telephone number. |
| string | Specifies the vendor's email address. | |
| website | string | Specifies the vendor's home page address. |
| taxRegistrationNumber | string | Specified the tax registration number of the vendor. |
| currencyId | GUID | Specifies which currency the vendor uses. |
| currencyCode | string | The default currency code for the vendor. |
| irs1099Code | string | Specifies a 1099 code for the vendor. US only. |
| 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 | NAV.vendorBlocked | Specifies which transactions with the customer can't be posted. It can be <Member Name=" ", "Payment" or "All". |
| balance | decimal | Specifies vendor's total balance. |
| lastModifiedDateTime | datetime | The 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"
}