List Customers

Returns a list of customers

GET/companies({company_id})/customers

Use it in a workflow

Add a step and choose the Microsoft Dynamics 365 Business Central connector.
Pick the List Customers action (under Business Central).
Fill in the fields below, then reference the result from later steps as {{listCustomers.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 {{listCustomers.response.data.<field>}}.

valuearray<object>

idstring (uuid)

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

numberstring

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

displayNamestring

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

typestring

(v1.0) The type property for the Dynamics 365 Business Central customer entity

addressobject12 fields

phoneNumberstring

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

emailstring

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

websitestring

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

taxLiableboolean

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

taxAreaIdstring (uuid)

(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity

taxAreaDisplayNamestring

(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity

taxRegistrationNumberstring

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

currencyIdstring (uuid)

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

currencyCodestring

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

paymentTermsIdstring (uuid)

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

shipmentMethodIdstring (uuid)

(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity

paymentMethodIdstring (uuid)

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

blockedstring

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

lastModifiedDateTimestring (date-time)

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

customerFinancialDetailsarray<object>5 fields

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

currencyobject7 fields

paymentTermobject8 fields

shipmentMethodobject4 fields

paymentMethodobject4 fields

json

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "displayName": "string",
      "type": "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",
      "taxLiable": false,
      "taxAreaId": "00000000-0000-0000-0000-000000000000",
      "taxAreaDisplayName": "string",
      "taxRegistrationNumber": "string"
    }
  ]
}

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

Was this page helpful?