Returns a list of customers

Request

Security

oAuthoauth2 (OAuth 2.0)
OAuth2oauth2 (OAuth 2.0)

Path

company_idstring (uuid)required
(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1

Query

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

Example: 100
$skipinteger
(v1.0) Number of items to skip from the list

Example: 0
$limitinteger
(v1.0) Number of items to return from the list

Example: 100
$filterstring
(v1.0) Filtering expression
$expandArray of strings
(v1.0) Entities to expand
$selectArray of strings
(v1.0) Selected properties to be retrieved

Responses

(v1.0) Succesfully returned a list of customers

Body application/json

valueArray of objects (customer)
Show 25 properties
- idstring (uuid)
  (v1.0) The id property for the Dynamics 365 Business Central customer entity
  
  Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
- numberstring
  (v1.0) The number property for the Dynamics 365 Business Central customer entity
  
  Example: null
  <= 20 characters
- displayNamestring
  (v1.0) The displayName property for the Dynamics 365 Business Central customer entity
  
  Example:
  <= 100 characters
- typestring
  (v1.0) The type property for the Dynamics 365 Business Central customer entity
  
  Example: null
- phoneNumberstring
  (v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
  
  Example: null
  <= 30 characters
- emailstring
  (v1.0) The email property for the Dynamics 365 Business Central customer entity
  
  Example: null
  <= 80 characters
- websitestring
  (v1.0) The website property for the Dynamics 365 Business Central customer entity
  
  Example: null
  <= 80 characters
- taxLiableboolean
  (v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity
  
  Example: null
- taxAreaIdstring (uuid)
  (v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity
  
  Example: null
- taxAreaDisplayNamestring
  (v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity
  
  Example: null
- taxRegistrationNumberstring
  (v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity
  
  Example: null
  <= 20 characters
- currencyIdstring (uuid)
  (v1.0) The currencyId property for the Dynamics 365 Business Central customer entity
  
  Example: null
- currencyCodestring
  (v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity
  
  Example: null
- paymentTermsIdstring (uuid)
  (v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity
  
  Example: null
- shipmentMethodIdstring (uuid)
  (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity
  
  Example: null
- paymentMethodIdstring (uuid)
  (v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity
  
  Example: null
- blockedstring
  (v1.0) The blocked property for the Dynamics 365 Business Central customer entity
  
  Example: null
- lastModifiedDateTimestring (date-time)
  (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity
  
  Example: null
- customerFinancialDetailsArray of objects (customerFinancialDetail)
  Show 5 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central customerFinancialDetail entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - numberstring
    (v1.0) The number property for the Dynamics 365 Business Central customerFinancialDetail entity
    
    Example: null
    <= 20 characters
  - balancenumber (decimal)
    (v1.0) The balance property for the Dynamics 365 Business Central customerFinancialDetail entity
    
    Example: null
  - totalSalesExcludingTaxnumber (decimal)
    (v1.0) The totalSalesExcludingTax property for the Dynamics 365 Business Central customerFinancialDetail entity
    
    Example: null
  - overdueAmountnumber (decimal)
    (v1.0) The overdueAmount property for the Dynamics 365 Business Central customerFinancialDetail entity
    
    Example: null
- pictureArray of objects (picture)
  Show 6 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central picture entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - widthinteger (int32)
    (v1.0) The width property for the Dynamics 365 Business Central picture entity
    
    Example: null
  - heightinteger (int32)
    (v1.0) The height property for the Dynamics 365 Business Central picture entity
    
    Example: null
  - contentTypestring
    (v1.0) The contentType property for the Dynamics 365 Business Central picture entity
    
    Example: null
    <= 100 characters
  - content@odata.mediaEditLinkstring (uri)
    (v1.0) The content@odata.mediaEditLink property for the Dynamics 365 Business Central picture entity
    
    Example: null
  - content@odata.mediaReadLinkstring (uri)
    (v1.0) The content@odata.mediaReadLink property for the Dynamics 365 Business Central picture entity
    
    Example: null
- defaultDimensionsArray of objects (defaultDimensions)
  Show 9 properties
  - parentIdstring (uuid)
    (v1.0) The parentId property for the Dynamics 365 Business Central defaultDimensions entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - dimensionIdstring (uuid)
    (v1.0) The dimensionId property for the Dynamics 365 Business Central defaultDimensions entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - dimensionCodestring
    (v1.0) The dimensionCode property for the Dynamics 365 Business Central defaultDimensions entity
    
    Example: null
    <= 20 characters
  - dimensionValueIdstring (uuid)
    (v1.0) The dimensionValueId property for the Dynamics 365 Business Central defaultDimensions entity
    
    Example: null
  - dimensionValueCodestring
    (v1.0) The dimensionValueCode property for the Dynamics 365 Business Central defaultDimensions entity
    
    Example: null
    <= 20 characters
  - postingValidationstring
    (v1.0) The postingValidation property for the Dynamics 365 Business Central defaultDimensions entity
    
    Example: null
  - accountobject (account)
    Show 7 properties
    idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central account entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
    numberstring
    (v1.0) The number property for the Dynamics 365 Business Central account entity
    
    Example: null
    <= 20 characters
    displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central account entity
    
    Example: null
    <= 100 characters
    categorystring
    (v1.0) The category property for the Dynamics 365 Business Central account entity
    
    Example: null
    subCategorystring
    (v1.0) The subCategory property for the Dynamics 365 Business Central account entity
    
    Example: null
    <= 80 characters
    blockedboolean
    (v1.0) The blocked property for the Dynamics 365 Business Central account entity
    
    Example: null
    lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central account entity
    
    Example: null
  - dimensionobject (dimension)
    Show 5 properties
    idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central dimension entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
    codestring
    (v1.0) The code property for the Dynamics 365 Business Central dimension entity
    
    Example: null
    <= 20 characters
    displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central dimension entity
    
    Example: null
    <= 30 characters
    lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central dimension entity
    
    Example: null
    dimensionValuesArray of objects (dimensionValue)
  - dimensionValueobject (dimensionValue)
    Show 4 properties
    idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central dimensionValue entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
    codestring
    (v1.0) The code property for the Dynamics 365 Business Central dimensionValue entity
    
    Example: null
    <= 20 characters
    displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central dimensionValue entity
    
    Example: null
    <= 50 characters
    lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central dimensionValue entity
    
    Example: null
- currencyobject (currency)
  Show 7 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central currency entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - codestring
    (v1.0) The code property for the Dynamics 365 Business Central currency entity
    
    Example: BKSD94GH
    <= 10 characters
  - displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central currency entity
    
    Example: null
    <= 30 characters
  - symbolstring
    (v1.0) The symbol property for the Dynamics 365 Business Central currency entity
    
    Example: null
    <= 10 characters
  - amountDecimalPlacesstring
    (v1.0) The amountDecimalPlaces property for the Dynamics 365 Business Central currency entity
    
    Example: null
    <= 5 characters
  - amountRoundingPrecisionnumber (decimal)
    (v1.0) The amountRoundingPrecision property for the Dynamics 365 Business Central currency entity
    
    Example: null
  - lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central currency entity
    
    Example: null
- paymentTermobject (paymentTerm)
  Show 8 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - codestring
    (v1.0) The code property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: JKHB9XER3
    <= 10 characters
  - displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: null
    <= 100 characters
  - dueDateCalculationstring
    (v1.0) The dueDateCalculation property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: null
  - discountDateCalculationstring
    (v1.0) The discountDateCalculation property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: null
  - discountPercentnumber (decimal)
    (v1.0) The discountPercent property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: null
  - calculateDiscountOnCreditMemosboolean
    (v1.0) The calculateDiscountOnCreditMemos property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: null
  - lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentTerm entity
    
    Example: null
- shipmentMethodobject (shipmentMethod)
  Show 4 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central shipmentMethod entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - codestring
    (v1.0) The code property for the Dynamics 365 Business Central shipmentMethod entity
    
    Example: SP934M
    <= 10 characters
  - displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central shipmentMethod entity
    
    Example: null
    <= 100 characters
  - lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central shipmentMethod entity
    
    Example: null
- paymentMethodobject (paymentMethod)
  Show 4 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central paymentMethod entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - codestring
    (v1.0) The code property for the Dynamics 365 Business Central paymentMethod entity
    
    Example: PM-001
    <= 10 characters
  - displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central paymentMethod entity
    
    Example: null
    <= 100 characters
  - lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentMethod entity
    
    Example: null

get /companies({company_id})/customers

curl -X GET \
  'https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

const url = 'https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <YOUR_TOKEN_HERE>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const fetch = require('node-fetch');

const url = 'https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <YOUR_TOKEN_HERE>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers"

headers = {"Authorization": "Bearer <YOUR_TOKEN_HERE>"}

response = requests.get(url, headers=headers)

print(response.json())

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers")
  .get()
  .addHeader("Authorization", "Bearer <YOUR_TOKEN_HERE>")
  .build();

Response response = client.newCall(request).execute();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers"),
  Headers =
  {
    { "Authorization", "Bearer <YOUR_TOKEN_HERE>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <YOUR_TOKEN_HERE>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

application/json

{
  "value": [
    {
      "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
      "number": null,
      "displayName": "",
      "type": null,
      "phoneNumber": null,
      "email": null,
      "website": null,
      "taxLiable": null,
      "taxAreaId": null,
      "taxAreaDisplayName": null,
      "taxRegistrationNumber": null,
      "currencyId": null,
      "currencyCode": null,
      "paymentTermsId": null,
      "shipmentMethodId": null,
      "paymentMethodId": null,
      "blocked": null,
      "lastModifiedDateTime": null,
      "customerFinancialDetails": [
        null
      ],
      "picture": [
        null
      ],
      "defaultDimensions": [
        null
      ],
      "currency": {},
      "paymentTerm": {},
      "shipmentMethod": {},
      "paymentMethod": {}
    }
  ]
}

Returns a list of customers

Request

Security

Path

Query

Responses200

Body application/json

Responses