Get Vendor

Retrieve the properties and relationships of an object of type vendor for Dynamics 365 Business Central.

GET/companies({company_id})/vendors({vendor_id})

Use it in a workflow

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

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

vendor_idstring (uuid)required

(v1.0) id for vendor

Query parameters

$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 {{getVendor.response.data.<field>}}.

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

addressobject

streetstring

(v1.0) The street property for the Dynamics 365 Business Central postaladdresstype entity

citystring

(v1.0) The city property for the Dynamics 365 Business Central postaladdresstype entity

statestring

(v1.0) The state property for the Dynamics 365 Business Central postaladdresstype entity

countryLetterCodestring

(v1.0) The countryLetterCode property for the Dynamics 365 Business Central postaladdresstype entity

postalCodestring

(v1.0) The postalCode property for the Dynamics 365 Business Central postaladdresstype entity

customerFinancialDetailsarray<object>5 fields

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

currencyobject7 fields

paymentTermobject8 fields

shipmentMethodobject4 fields

paymentMethodobject4 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>

idstring (uuid)

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

widthinteger (int32)

(v1.0) The width property for the Dynamics 365 Business Central picture entity

heightinteger (int32)

(v1.0) The height property for the Dynamics 365 Business Central picture entity

contentTypestring

(v1.0) The contentType property for the Dynamics 365 Business Central picture entity

content@odata.mediaEditLinkstring (uri)

(v1.0) The content@odata.mediaEditLink property for the Dynamics 365 Business Central picture entity

content@odata.mediaReadLinkstring (uri)

(v1.0) The content@odata.mediaReadLink property for the Dynamics 365 Business Central picture entity

defaultDimensionsarray<object>

parentIdstring (uuid)

(v1.0) The parentId property for the Dynamics 365 Business Central defaultDimensions entity

dimensionIdstring (uuid)

(v1.0) The dimensionId property for the Dynamics 365 Business Central defaultDimensions entity

dimensionCodestring

(v1.0) The dimensionCode property for the Dynamics 365 Business Central defaultDimensions entity

dimensionValueIdstring (uuid)

(v1.0) The dimensionValueId property for the Dynamics 365 Business Central defaultDimensions entity

dimensionValueCodestring

(v1.0) The dimensionValueCode property for the Dynamics 365 Business Central defaultDimensions entity

postingValidationstring

(v1.0) The postingValidation property for the Dynamics 365 Business Central defaultDimensions entity

accountobject

(schema truncated: exceeded maximum nesting depth)

dimensionobject

(schema truncated: exceeded maximum nesting depth)

dimensionValueobject

(schema truncated: exceeded maximum nesting depth)

currencyobject

idstring (uuid)

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

codestring

(v1.0) The code property for the Dynamics 365 Business Central currency entity

displayNamestring

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

symbolstring

(v1.0) The symbol property for the Dynamics 365 Business Central currency entity

amountDecimalPlacesstring

(v1.0) The amountDecimalPlaces property for the Dynamics 365 Business Central currency entity

amountRoundingPrecisionnumber (decimal)

(v1.0) The amountRoundingPrecision property for the Dynamics 365 Business Central currency entity

lastModifiedDateTimestring (date-time)

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

paymentTermobject

idstring (uuid)

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

codestring

(v1.0) The code property for the Dynamics 365 Business Central paymentTerm entity

displayNamestring

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

dueDateCalculationstring

(v1.0) The dueDateCalculation property for the Dynamics 365 Business Central paymentTerm entity

discountDateCalculationstring

(v1.0) The discountDateCalculation property for the Dynamics 365 Business Central paymentTerm entity

discountPercentnumber (decimal)

(v1.0) The discountPercent property for the Dynamics 365 Business Central paymentTerm entity

calculateDiscountOnCreditMemosboolean

(v1.0) The calculateDiscountOnCreditMemos property for the Dynamics 365 Business Central paymentTerm entity

lastModifiedDateTimestring (date-time)

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

paymentMethodobject

idstring (uuid)

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

codestring

(v1.0) The code property for the Dynamics 365 Business Central paymentMethod entity

displayNamestring

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

lastModifiedDateTimestring (date-time)

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

json

{
  "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?