Microsoft Dynamics 365 Business Central

Microsoft Dynamics 365 Business Central Customers API

Customer master data

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 5

GET /companies({companyId})/customers List customers in a company #
POST /companies({companyId})/customers Create a customer #
GET /companies({companyId})/customers({id}) Get a customer #
PATCH /companies({companyId})/customers({id}) Update a customer #
DELETE /companies({companyId})/customers({id}) Delete a customer #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/
📖
Authentication
https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/automation-apis-using-s2s-authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-dynamics-365-business-central/openapi/microsoft-dynamics-365-business-central-customers-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-dynamics-365-business-central/json-schema/microsoft-dynamics-365-business-central-customer-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-dynamics-365-business-central/json-schema/microsoft-dynamics-365-business-central-customer-collection-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-dynamics-365-business-central:microsoft-dynamics-365-business-central-customers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-dynamics-365-business-central-customers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Dynamics 365 Business Central API v2.0 Customers…
  description: 'Standard REST API (v2.0) for Microsoft Dynamics 365 Business Central.

    Exposes Business Central entities such as companies, customers, vendors,

    items, sales documents, purchase documents, and journals via an OData v4

    interface. Authentication uses OAuth 2.0 (Microsoft Entra ID) bearer

    tokens supporting both delegated user and service-to-service flows.


    URLs follow the pattern:

    https://api.businesscentral.dynamics.com/v2.0/{environment}/api/v2.0'
  version: v2.0
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: Microsoft Terms of Use
    url: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://api.businesscentral.dynamics.com/v2.0/{environment}/api/v2.0
  description: Business Central production environment
  variables:
    environment:
      default: production
      description: Business Central environment name
security:
- oauth2: []
tags:
- name: Customers
  description: Customer master data
paths:
  /companies({companyId})/customers:
    get:
      tags:
      - Customers
      summary: List customers in a company
      operationId: customers_list
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/expand'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/top'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerCollection'
    post:
      tags:
      - Customers
      summary: Create a customer
      operationId: customers_create
      parameters:
      - $ref: '#/components/parameters/companyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Customer'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
  /companies({companyId})/customers({id}):
    get:
      tags:
      - Customers
      summary: Get a customer
      operationId: customers_get
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
    patch:
      tags:
      - Customers
      summary: Update a customer
      operationId: customers_update
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/ifMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Customer'
      responses:
        '200':
          description: OK
    delete:
      tags:
      - Customers
      summary: Delete a customer
      operationId: customers_delete
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/ifMatch'
      responses:
        '204':
          description: No Content
components:
  schemas:
    Customer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
        displayName:
          type: string
        type:
          type: string
          enum:
          - Company
          - Person
        addressLine1:
          type: string
        addressLine2:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postalCode:
          type: string
        phoneNumber:
          type: string
        email:
          type: string
        website:
          type: string
        taxLiable:
          type: boolean
        taxAreaId:
          type: string
          format: uuid
        currencyId:
          type: string
          format: uuid
        currencyCode:
          type: string
        paymentTermsId:
          type: string
          format: uuid
        shipmentMethodId:
          type: string
          format: uuid
        paymentMethodId:
          type: string
          format: uuid
        blocked:
          type: string
        lastModifiedDateTime:
          type: string
          format: date-time
    CustomerCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
  parameters:
    id:
      name: id
      in: path
      required: true
      description: GUID identifier
      schema:
        type: string
        format: uuid
    top:
      name: $top
      in: query
      schema:
        type: integer
    expand:
      name: $expand
      in: query
      schema:
        type: string
    filter:
      name: $filter
      in: query
      schema:
        type: string
    companyId:
      name: companyId
      in: path
      required: true
      description: Company GUID
      schema:
        type: string
        format: uuid
    ifMatch:
      name: If-Match
      in: header
      description: ETag for optimistic concurrency
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: Microsoft Entra ID OAuth 2.0
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://api.businesscentral.dynamics.com/.default: Business Central API access