---
title: "API vendor"
slug: "api-vendor"
description: "Comprehensive reference for Softera’s Vendor API, detailing vendor fields, financial data, bank accounts, dimensions, and contact information."
tags: ["Business Central API", "Integration", "API", "Instrukcijos", "Business Central"]
updated: 2026-09-09T16:06:28Z
published: 2026-09-09T16:06:28Z
canonical: "instrukcijos.softera.lt/api-vendor"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://instrukcijos.softera.lt/llms.txt
> Use this file to discover all available pages before exploring further.

# vendor

| **API** | **Path** |
| --- | --- |
| vendors | businesscentralPrefix/softera/softeraEInvoice/v2.0/companies({{companyId}})/vendors |

**Methods**

| Method | Return Type | Description |
| --- | --- | --- |
| GET vendor | vendor | Gets a vendor object. |
| POST vendor | vendor | Creates a vendor object. |
| PATCH vendor | vendor | Updates a vendor object. |
| DELETE vendor | none | Deletes a vendor object. |

              Important

              

If **Assign Default Template** is enabled in API Setup, `vendorTemplateCode` does not need to be sent in the request — it will be assigned automatically based on the vendor's country (Local / EU / Foreign Vendor Template). See [API Setup](https://instrukcijos.softera.lt/docs/en/api-setup) for configuration.

              Tip

              

Business Central can check for duplicate vendors before creating a new one, based on **Registration Number** (`registrationNumber` / `taxRegistrationNumber`) or **Name** (`displayName`). Enable this via **Check Duplicates by Reg. No.** and **Check Duplicates by Name** in [API Setup](https://instrukcijos.softera.lt/docs/en/api-setup) — if a matching record is found, the request is rejected with an error instead of creating a duplicate.

**Fields**

| Name | Type | MaxLength | Description |
| --- | --- | --- | --- |
| id | Guid |  |  |
| number | String | 20 |  |
| displayName | String | 100 |  |
| addressLine1 | String | 100 |  |
| addressLine2 | String | 50 |  |
| country | String | 10 |  |
| city | String | 30 |  |
| state | String | 30 |  |
| postalCode | String | 20 |  |
| phoneNumber | String | 30 |  |
| mobilePhoneNumber | String | 30 |  |
| email | String | 80 |  |
| website | String | 80 |  |
| purchaserCode | String | 20 |  |
| taxRegistrationNumber | String | 20 |  |
| registrationNumber | String | 50 |  |
| currencyId | Guid |  |  |
| currencyCode | String |  |  |
| irs1099Code | String |  |  |
| paymentTermsId | Guid |  |  |
| paymentTermsCode | String | 10 |  |
| paymentMethodId | Guid |  |  |
| taxLiable | Boolean |  |  |
| blocked | String |  |  |
| balance | Decimal |  |  |
| languageCode | String | 10 |  |
| partnerType | String |  |  |
| preferredBankAccountCode | String | 20 |  |
| vendorTemplateCode | String |  |  |
| vendorLink | String | 250 |  |
| globalDimension1Code | String | 20 |  |
| globalDimension2Code | String | 20 |  |
| lastModifiedDateTime | DateTimeOffset |  | Read-only |

**Related API's (expand)**

| Name | Type | Description |
| --- | --- | --- |
| vendorBankAccount | Microsoft.NAV.vendorBankAccount |  |
| vendorBankAccounts | Collection(Microsoft.NAV.vendorBankAccount) |  |
| picture | Microsoft.NAV.picture |  |
| defaultDimensions | Collection(Microsoft.NAV.defaultDimension) |  |
| agedAccountsPayable | Microsoft.NAV.agedAccountsPayable |  |
| contactsInformation | Collection(Microsoft.NAV.contactInformation) |  |