Microsoft 365 GetCustomer

Microsoft 365 GetCustomer
Certified
Get a Business Central customer

Retrieves a single customer record from Business Central by company ID and customer ID. Requires the Financials.ReadWrite.All API permission on the service principal.

yaml
type: io.kestra.plugin.microsoft365.dynamics365.businesscentral.GetCustomer

Examples

Get a customer by ID from Business Central

yaml
id: bc_get_customer
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.microsoft365.dynamics365.businesscentral.GetCustomer
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    environment: production
    companyId: "00000000-0000-0000-0000-000000000001"
    customerId: "00000000-0000-0000-0000-000000000002"

Properties

clientId *string

Client ID

Client ID of the Azure service principal. If you don't have a service principal, refer to create a service principal with Azure CLI.

companyId *string

Company ID

GUID of the Business Central company.

customerId *string

Customer ID

GUID of the customer to retrieve.

environment *string

Business Central Environment Name

Name of the Business Central environment to target, e.g. production or sandbox. This is combined with the tenant ID to form the base URL: https://api.businesscentral.dynamics.com/v2.0/{tenantId}/{environment}/api/v2.0.

tenantId *string

Tenant ID

Azure AD (Entra ID) tenant GUID used for authentication.

apiEndpoint string

Business Central API endpoint

Override the Business Central API base URL. Useful for sovereign clouds (e.g. GovCloud, China). Defaults to https://api.businesscentral.dynamics.com when not set.

clientSecret string

Client Secret

Service principal client secret. Use this for Client Secret authentication. Provide clientId, tenantId, and clientSecret. Either clientSecret OR pemCertificate must be provided, not both.

pemCertificate string

PEM Certificate

Alternative authentication method using certificate-based authentication. Use this for Client Certificate authentication. Provide clientId, tenantId, and pemCertificate. Either clientSecret OR pemCertificate must be provided, not both.