Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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
| Method | Return Type | Description |
|---|---|---|
| GET vendors | vendors | Gets a vendor object. |
| POST vendors | vendors | Creates a vendor object. |
| PATCH vendors | vendors | Updates a vendor object. |
| DELETE vendor | none | Deletes a vendor object. |
Navigation
| Go to | Type | Description |
|---|---|---|
| Picture | picture | Gets the picture of vendor. |
| defaultDimensions | defaultDimension | Gets the defaultDimension of vendor. |
| currency | currency | Gets the currency of vendor. |
| paymentTerm | paymentTerm | Gets the paymentTerm of vendor. |
| paymentMethod | paymentMethod | Gets the paymentMethod of vendor. |
Properties
| Property | Type | Description |
|---|---|---|
| id | GUID | The unique ID of the vendor. Non-editable. |
| number | string | The vendor number. |
| displayName | string | The vendor's display name. |
| address | NAV.PostalAddress | The vendor's address. |
| phoneNumber | string | The vendor's telephone number. |
| string | The vendor's email address. | |
| website | string | The vendor's website address. |
| taxRegistrationNumber | string | The vendor's tax registration number. |
| currencyId | GUID | The default currency code ID for the vendor. |
| currencyCode | string | The default currency code for the vendor. |
| irs1099Code | string | Specifies a 1099 code for the vendor. US only. |
| paymentTermsId | GUID | The default payment terms ID for the vendor. |
| paymentMethodId | GUID | The default payment method ID for the vendor. |
| taxLiable | boolean | Specifies if the vendor is liable for tax. |
| blocked | string | Specifies which transactions with the vendor that cannot be posted. Accepted values are blank, Payment or All |
| balance | decimal | The vendor's balance. Read-Only. |
| lastModifiedDateTime | datetime | The 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"
}