Class GetBusinessCentralCustomersAction

Action to retrieve customers from Microsoft Dynamics 365 Business Central

Hierarchy (View Summary)

BusinessCentralBaseAction
- GetBusinessCentralCustomersAction

Constructors

constructor

new GetBusinessCentralCustomersAction(): GetBusinessCentralCustomersAction
Returns GetBusinessCentralCustomersAction
Inherited from BusinessCentralBaseAction.constructor

Properties

`Protected`accountingProvider

accountingProvider: string = 'Business Central'

The accounting provider this action is designed for (e.g., 'QuickBooks', 'NetSuite', etc.) Can be 'Generic' for provider-agnostic actions

`Protected`apiVersion

apiVersion: string = 'v2.0'

Business Central API version

`Protected`integrationName

integrationName: string = 'Microsoft Dynamics 365 Business Central'

The integration name to look up in the Integration entity

`Protected`params

params: any

Current action parameters (set by the framework)

`Static` `Readonly`AuthorizesCaller

AuthorizesCaller: boolean

True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

Accessors

Description

get Description(): string
Description of the action

Returns string
- Defined in BizApps/Accounting/src/providers/business-central/actions/get-customers.action.ts:50

Params

get Params(): ActionParam[]
Define the parameters for this action

Returns ActionParam[]
- Defined in BizApps/Accounting/src/providers/business-central/actions/get-customers.action.ts:290

Methods

`Protected`buildAccountingErrorMessage

buildAccountingErrorMessage(
    operation: string,
    details: string,
    systemError?: any,
): string
Helper to build consistent error messages for accounting operations
Parameters
- operation: string
- details: string
- OptionalsystemError: any
Returns string
Inherited from BusinessCentralBaseAction.buildAccountingErrorMessage
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:197

`Protected`buildFilterExpression

buildFilterExpression(field: string, operator: string, value: any): string
Helper to build OData filter expressions
Parameters
- field: string
- operator: string
- value: any
Returns string
Inherited from BusinessCentralBaseAction.buildFilterExpression
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:205

`Protected`formatAccountingDate

formatAccountingDate(date: Date): string
Standard date format for accounting systems (ISO 8601)
Parameters
- date: Date
Returns string
Inherited from BusinessCentralBaseAction.formatAccountingDate
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:190

`Protected`formatBCDate

formatBCDate(date: Date): string
Formats date for Business Central API (ISO 8601)
Parameters
- date: Date
Returns string
Inherited from BusinessCentralBaseAction.formatBCDate
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:147

`Protected`formatCurrency

formatCurrency(amount: number, currencyCode?: string): string
Formats currency values consistently
Parameters
- amount: number
- currencyCode: string = 'USD'
Returns string
Inherited from BusinessCentralBaseAction.formatCurrency
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:178

`Protected`getAPIBaseURL

getAPIBaseURL(
contextUser: UserInfo,
provider?: IMetadataProvider,
): Promise<string>
Gets the base URL for API calls from the integration
Parameters
- contextUser: UserInfo
- Optionalprovider: IMetadataProvider
Returns Promise<string>
Inherited from BusinessCentralBaseAction.getAPIBaseURL
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:140

`Protected`getBusinessCentralAPIUrl

getBusinessCentralAPIUrl(
    integration: MJCompanyIntegrationEntity,
    tenantId: string,
    environment: string,
): Promise<string>
Gets the appropriate Business Central API URL
Parameters
- integration: MJCompanyIntegrationEntity
- tenantId: string
- environment: string
Returns Promise<string>
Inherited from BusinessCentralBaseAction.getBusinessCentralAPIUrl
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:192

`Protected`getCommonAccountingParams

getCommonAccountingParams(): ActionParam[]
Common accounting parameters that many actions will need

Returns ActionParam[]
Inherited from BusinessCentralBaseAction.getCommonAccountingParams
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:46

`Protected`getCompanyIntegration

getCompanyIntegration(
companyId: string,
contextUser: UserInfo,
): Promise<MJCompanyIntegrationEntity>
Gets the company integration record for the specified company and accounting system
Parameters
- companyId: string
- contextUser: UserInfo
Returns Promise<MJCompanyIntegrationEntity>
Inherited from BusinessCentralBaseAction.getCompanyIntegration
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:69

`Protected`getCredentialFromEnv

getCredentialFromEnv(companyId: string, credentialType: string): string
Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_QUICKBOOKS_12345_ACCESS_TOKEN
Parameters
- companyId: string
- credentialType: string
Returns string
Inherited from BusinessCentralBaseAction.getCredentialFromEnv
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:99

`Protected`getOAuthTokens

getOAuthTokens(
integration: MJCompanyIntegrationEntity,
): Promise<{ accessToken: string; refreshToken?: string }>
Gets OAuth tokens - first tries environment variables, then falls back to database
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<{ accessToken: string; refreshToken?: string }>
Inherited from BusinessCentralBaseAction.getOAuthTokens
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:107

`Protected`getParamValue

getParamValue(params: ActionParam[], name: string): any
Helper to get a parameter value from the params array
Parameters
- params: ActionParam[]
- name: string
Returns any
Inherited from BusinessCentralBaseAction.getParamValue
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:38

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Main execution method
Parameters
- params: RunActionParams
Returns Promise<ActionResultSimple>
Overrides BusinessCentralBaseAction.InternalRunAction
- Defined in BizApps/Accounting/src/providers/business-central/actions/get-customers.action.ts:57

`Protected`makeBCRequest

makeBCRequest<T = any>(
    endpoint: string,
    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH",
    body?: any,
    contextUser?: UserInfo,
): Promise<T>
Makes an authenticated request to Business Central API
Type Parameters
- T = any
Parameters
- endpoint: string
- method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" = 'GET'
- Optionalbody: any
- OptionalcontextUser: UserInfo
Returns Promise<T>
Inherited from BusinessCentralBaseAction.makeBCRequest
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:24

`Protected`mapAccountCategory

mapAccountCategory(category: string): string
Maps Business Central account category to standard type
Parameters
- category: string
Returns string
Inherited from BusinessCentralBaseAction.mapAccountCategory
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:176

`Protected`mapAccountType

mapAccountType(bcAccountType: string): string
Maps Business Central account types to standard categories
Parameters
- bcAccountType: string
Returns string
Inherited from BusinessCentralBaseAction.mapAccountType
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:161

`Protected`parseBCDate

parseBCDate(dateString: string): Date
Parses Business Central date format
Parameters
- dateString: string
Returns Date
Inherited from BusinessCentralBaseAction.parseBCDate
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:154

`Protected`queryBC

queryBC<T = any>(
    resource: string,
    filters?: string[],
    select?: string[],
    expand?: string[],
    orderBy?: string,
    top?: number,
    contextUser?: UserInfo,
): Promise<T>
Handles Business Central OData queries
Type Parameters
- T = any
Parameters
- resource: string
- Optionalfilters: string[]
- Optionalselect: string[]
- Optionalexpand: string[]
- OptionalorderBy: string
- Optionaltop: number
- OptionalcontextUser: UserInfo
Returns Promise<T>
Inherited from BusinessCentralBaseAction.queryBC
- Defined in BizApps/Accounting/src/providers/business-central/business-central-base.action.ts:109

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BusinessCentralBaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:49

`Protected`validateAccountNumber

validateAccountNumber(accountNumber: string): boolean
Validates common accounting data formats
Parameters
- accountNumber: string
Returns boolean
Inherited from BusinessCentralBaseAction.validateAccountNumber
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:161

`Protected`validateJournalEntryBalance

validateJournalEntryBalance(
lines: { credit?: number; debit?: number }[],
): boolean
Validates journal entry balance (debits must equal credits)
Parameters
- lines: { credit?: number; debit?: number }[]
Returns boolean
Inherited from BusinessCentralBaseAction.validateJournalEntryBalance
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:169

Class GetBusinessCentralCustomersAction

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GetBusinessCentralCustomersAction

Properties

ProtectedaccountingProvider

ProtectedapiVersion

ProtectedintegrationName

Protectedparams

Static ReadonlyAuthorizesCaller

Accessors

Description

Returns string

Params

Returns ActionParam[]

Methods

ProtectedbuildAccountingErrorMessage

Parameters

Returns string

ProtectedbuildFilterExpression

Parameters

Returns string

ProtectedformatAccountingDate

Parameters

Returns string

ProtectedformatBCDate

Parameters

Returns string

ProtectedformatCurrency

Parameters

Returns string

ProtectedgetAPIBaseURL

Parameters

Returns Promise<string>

ProtectedgetBusinessCentralAPIUrl

Parameters

Returns Promise<string>

ProtectedgetCommonAccountingParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string

ProtectedgetOAuthTokens

Parameters

Returns Promise<{ accessToken: string; refreshToken?: string }>

ProtectedgetParamValue

Parameters

Returns any

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedmakeBCRequest

Type Parameters

Parameters

Returns Promise<T>

ProtectedmapAccountCategory

Parameters

Returns string

ProtectedmapAccountType

Parameters

Returns string

ProtectedparseBCDate

Parameters

Returns Date

ProtectedqueryBC

Type Parameters

Parameters

Returns Promise<T>

Run

Parameters

Returns Promise<ActionResultSimple>

`Protected`accountingProvider

`Protected`apiVersion

`Protected`integrationName

`Protected`params

`Static` `Readonly`AuthorizesCaller

`Protected`buildAccountingErrorMessage

`Protected`buildFilterExpression

`Protected`formatAccountingDate

`Protected`formatBCDate

`Protected`formatCurrency

`Protected`getAPIBaseURL

`Protected`getBusinessCentralAPIUrl

`Protected`getCommonAccountingParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getOAuthTokens

`Protected`getParamValue

`Protected`InternalRunAction

`Protected`makeBCRequest

`Protected`mapAccountCategory

`Protected`mapAccountType

`Protected`parseBCDate

`Protected`queryBC

`Protected`validateAccountNumber

`Protected`validateJournalEntryBalance