List Companies

Returns a list of companies

GET/companies

Use it in a workflow

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

Request

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

$selectarray<string>

(v1.0) Selected properties to be retrieved

Response

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

valuearray<object>

idstring (uuid)

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

systemVersionstring

(v1.0) The systemVersion property for the Dynamics 365 Business Central company entity

namestring

(v1.0) The name property for the Dynamics 365 Business Central company entity

displayNamestring

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

businessProfileIdstring

(v1.0) The businessProfileId property for the Dynamics 365 Business Central company entity

itemsarray<object>20 fields

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

customersarray<object>26 fields

customerFinancialDetailsarray<object>5 fields

vendorsarray<object>22 fields

companyInformationarray<object>13 fields

salesInvoicesarray<object>40 fields

salesInvoiceLinesarray<object>27 fields

pdfDocumentarray<object>2 fields

customerPaymentJournalsarray<object>8 fields

customerPaymentsarray<object>17 fields

accountsarray<object>

taxGroupsarray<object>5 fields

journalsarray<object>8 fields

journalLinesarray<object>16 fields

attachmentsarray<object>6 fields

employeesarray<object>21 fields

timeRegistrationEntriesarray<object>15 fields

generalLedgerEntriesarray<object>12 fields

currenciesarray<object>7 fields

paymentMethodsarray<object>4 fields

dimensionsarray<object>

dimensionValuesarray<object>

dimensionLinesarray<object>8 fields

paymentTermsarray<object>8 fields

shipmentMethodsarray<object>4 fields

itemCategoriesarray<object>4 fields

cashFlowStatementarray<object>6 fields

countriesRegionsarray<object>5 fields

salesOrdersarray<object>39 fields

salesOrderLinesarray<object>31 fields

retainedEarningsStatementarray<object>6 fields

unitsOfMeasurearray<object>5 fields

agedAccountsReceivablearray<object>11 fields

json

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "systemVersion": "string",
      "name": "string",
      "displayName": "string",
      "businessProfileId": "string",
      "items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "displayName": "string",
          "type": "string",
          "itemCategoryId": "00000000-0000-0000-0000-000000000000",
          "itemCategoryCode": "string",
          "blocked": false,
          "baseUnitOfMeasureId": "00000000-0000-0000-0000-000000000000",
          "baseUnitOfMeasure": {
            "code": "string",
            "displayName": "string",
            "symbol": "string",
            "unitConversion": {
              "toUnitOfMeasure": null,
              "fromToConversionRate": null,
              "picture": null,
              "defaultDimensions": null,
              "itemCategory": null
            },
            "picture": [
              null
            ],
            "defaultDimensions": [
              null
            ],
            "itemCategory": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            }
          },
          "gtin": "string",
          "inventory": 0,
          "unitPrice": 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": {}
        }
      ],
      "customers": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "displayName": "string",
          "type": "string",
          "address": {
            "street": "string",
            "city": "string",
            "state": "string",
            "countryLetterCode": "string",
            "postalCode": "string",
            "customerFinancialDetails": [
              null
            ],
            "picture": [
              null
            ],
            "defaultDimensions": [
              null
            ],
            "currency": {
              "id": null,
              "code": null,
              "displayName": null,
              "symbol": null,
              "amountDecimalPlaces": null,
              "amountRoundingPrecision": null,
              "lastModifiedDateTime": null
            },
            "paymentTerm": {
              "id": null,
              "code": null,
              "displayName": null,
              "dueDateCalculation": null,
              "discountDateCalculation": null,
              "discountPercent": null,
              "calculateDiscountOnCreditMemos": null,
              "lastModifiedDateTime": null
            },
            "shipmentMethod": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            },
            "paymentMethod": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            }
          },
          "phoneNumber": "string",
          "email": "string",
          "website": "string",
          "taxLiable": false,
          "taxAreaId": "00000000-0000-0000-0000-000000000000",
          "taxAreaDisplayName": "string",
          "taxRegistrationNumber": "string"
        }
      ],
      "customerFinancialDetails": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "balance": 0,
          "totalSalesExcludingTax": 0,
          "overdueAmount": 0
        }
      ],
      "vendors": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "displayName": "string",
          "address": {
            "street": "string",
            "city": "string",
            "state": "string",
            "countryLetterCode": "string",
            "postalCode": "string",
            "customerFinancialDetails": [
              null
            ],
            "picture": [
              null
            ],
            "defaultDimensions": [
              null
            ],
            "currency": {
              "id": null,
              "code": null,
              "displayName": null,
              "symbol": null,
              "amountDecimalPlaces": null,
              "amountRoundingPrecision": null,
              "lastModifiedDateTime": null
            },
            "paymentTerm": {
              "id": null,
              "code": null,
              "displayName": null,
              "dueDateCalculation": null,
              "discountDateCalculation": null,
              "discountPercent": null,
              "calculateDiscountOnCreditMemos": null,
              "lastModifiedDateTime": null
            },
            "shipmentMethod": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            },
            "paymentMethod": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            }
          },
          "phoneNumber": "string",
          "email": "string",
          "website": "string",
          "taxRegistrationNumber": "string",
          "currencyId": "00000000-0000-0000-0000-000000000000",
          "currencyCode": "string",
          "irs1099Code": "string",
          "paymentTermsId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "companyInformation": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "string",
          "address": {
            "street": "string",
            "city": "string",
            "state": "string",
            "countryLetterCode": "string",
            "postalCode": "string",
            "customerFinancialDetails": [
              null
            ],
            "picture": [
              null
            ],
            "defaultDimensions": [
              null
            ],
            "currency": {
              "id": null,
              "code": null,
              "displayName": null,
              "symbol": null,
              "amountDecimalPlaces": null,
              "amountRoundingPrecision": null,
              "lastModifiedDateTime": null
            },
            "paymentTerm": {
              "id": null,
              "code": null,
              "displayName": null,
              "dueDateCalculation": null,
              "discountDateCalculation": null,
              "discountPercent": null,
              "calculateDiscountOnCreditMemos": null,
              "lastModifiedDateTime": null
            },
            "shipmentMethod": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            },
            "paymentMethod": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            }
          },
          "phoneNumber": "string",
          "faxNumber": "string",
          "email": "string",
          "website": "string",
          "taxRegistrationNumber": "string",
          "currencyCode": "string",
          "currentFiscalYearStartDate": "2025-01-01T00:00:00Z",
          "industry": "string",
          "picture": "string"
        }
      ]
    }
  ]
}

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

Was this page helpful?