List Vendors

Returns a list of vendors

GET/companies({company_id})/vendors

Use it in a workflow

Add a step and choose the Microsoft Dynamics 365 Business Central connector.
Pick the List Vendors action (under Business Central).
Fill in the fields below, then reference the result from later steps as {{listVendors.response.data}}.

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

Query parameters

$topinteger

(v1.0) Number of items to return from the top of the list

$skipinteger

(v1.0) Number of items to skip from the list

$limitinteger

(v1.0) Number of items to return from the list

$filterstring

(v1.0) Filtering expression

$expandarray<string>

(v1.0) Entities to expand

$selectarray<string>

(v1.0) Selected properties to be retrieved

Response

Returns 200 with an object. Read it in later steps with {{listVendors.response.data.<field>}}.

valuearray<object>

idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central vendor entity

numberstring

(v1.0) The number property for the Dynamics 365 Business Central vendor entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central vendor entity

addressobject12 fields

phoneNumberstring

(v1.0) The phoneNumber property for the Dynamics 365 Business Central vendor entity

emailstring

(v1.0) The email property for the Dynamics 365 Business Central vendor entity

websitestring

(v1.0) The website property for the Dynamics 365 Business Central vendor entity

taxRegistrationNumberstring

(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central vendor entity

currencyIdstring (uuid)

(v1.0) The currencyId property for the Dynamics 365 Business Central vendor entity

currencyCodestring

(v1.0) The currencyCode property for the Dynamics 365 Business Central vendor entity

irs1099Codestring

(v1.0) The irs1099Code property for the Dynamics 365 Business Central vendor entity

paymentTermsIdstring (uuid)

(v1.0) The paymentTermsId property for the Dynamics 365 Business Central vendor entity

paymentMethodIdstring (uuid)

(v1.0) The paymentMethodId property for the Dynamics 365 Business Central vendor entity

taxLiableboolean

(v1.0) The taxLiable property for the Dynamics 365 Business Central vendor entity

blockedstring

(v1.0) The blocked property for the Dynamics 365 Business Central vendor entity

balancenumber (decimal)

(v1.0) The balance property for the Dynamics 365 Business Central vendor entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central vendor entity

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

currencyobject7 fields

paymentTermobject8 fields

paymentMethodobject4 fields

json

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "displayName": "string",
      "address": {
        "street": "string",
        "city": "string",
        "state": "string",
        "countryLetterCode": "string",
        "postalCode": "string",
        "customerFinancialDetails": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "number": "string",
            "balance": 0,
            "totalSalesExcludingTax": 0,
            "overdueAmount": 0
          }
        ],
        "picture": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "width": 0,
            "height": 0,
            "contentType": "string",
            "content@odata.mediaEditLink": "string",
            "content@odata.mediaReadLink": "string"
          }
        ],
        "defaultDimensions": [
          {
            "parentId": "00000000-0000-0000-0000-000000000000",
            "dimensionId": "00000000-0000-0000-0000-000000000000",
            "dimensionCode": "string",
            "dimensionValueId": "00000000-0000-0000-0000-000000000000",
            "dimensionValueCode": "string",
            "postingValidation": "string",
            "account": {},
            "dimension": {},
            "dimensionValue": {}
          }
        ],
        "currency": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "symbol": "string",
          "amountDecimalPlaces": "string",
          "amountRoundingPrecision": 0,
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        },
        "paymentTerm": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "dueDateCalculation": "string",
          "discountDateCalculation": "string",
          "discountPercent": 0,
          "calculateDiscountOnCreditMemos": false,
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        },
        "shipmentMethod": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        },
        "paymentMethod": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        }
      },
      "phoneNumber": "string",
      "email": "string",
      "website": "string",
      "taxRegistrationNumber": "string",
      "currencyId": "00000000-0000-0000-0000-000000000000",
      "currencyCode": "string",
      "irs1099Code": "string",
      "paymentTermsId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Need more? See the Microsoft Dynamics 365 Business Central guide for connection setup and behaviour shared by every action.

Was this page helpful?