Table of Contents

Getting started with API

Access to API

Note

For on-premise installations please talk with your Microsoft Partner, how to get the access. The documentation is written for Cloud environments.

Steps to Register Azure AD App for Pimics API Access

  1. Sign in to Azure Portal
  2. Create a New App Registration
    • Navigate to Azure Active Directory > App registrations
    • Click New registration
    • Fill in:
      • Name: e.g., Pimics API Access
      • Supported account types: Choose based on your organization setup
      • Redirect URI: Optional for client credentials flow
    • Click Register
    • See details in Microsoft Docs – Register an application
  3. Note Down App Details
    • After registration, copy:
      • Application (client) ID
      • Directory (tenant) ID
  4. Add API Permissions
    • Go to API permissions > Add a permission
    • Choose:
      • APIs my organization uses
      • Search for Dynamics 365 Business Central
    • Select Delegated permissions or Application permissions
    • Add permission: API.ReadWrite.All or similar
    • Click Grant admin consent
    • See details in Microsoft Docs – Permissions and consent
  5. Create a Client Secret

Steps to set permissions in Business Central

  1. Register Application in Business Central
    • Choose the Search icon (or use Alt + Q), enter Azure Active Directory Applications, then choose the related link.
    • Click New to register the app.
    • Fill in:
      • Client ID: from Azure AD
      • Description: e.g., "Pimics API Access"
      • State: Enabled
  2. Assign "PIMX USER" Permission Set
    • In the same Azure AD Application card:
      • Go to User Permissions
      • Add permission set: PIMX USER
    • This permission set must exist in your Business Central environment. If not, contact your system administrator or Pimics support to ensure it is deployed.

Test Connection

  1. Generate Access Token

    • Use the following OAuth2 token endpoint:

      https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

    • Request body (x-www-form-urlencoded):

      client_id=<your_client_id>
client_secret=<your_client_secret>
scope=https://api.businesscentral.dynamics.com/.default
grant_type=client_credentials

    • See details in Microsoft Docs – Client credentials flow

    • Token in your request headers:

      Authorization: Bearer <access_token>

    • API endpoint:

      https://api.businesscentral.dynamics.com/v2.0/{environment}/api/pimics/publication/v2.0