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

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

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.

Company ID

GUID of the Business Central company.

Customer ID

GUID of the customer to retrieve.

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.

Tenant ID

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

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.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

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.

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.

Customer record

Customer fields returned by Business Central.