Class BusinessCentralBaseAction`Abstract`

Base class for all Microsoft Dynamics 365 Business Central actions. Handles BC-specific authentication and API interaction patterns.

Hierarchy (View Summary)

BaseAccountingAction
- BusinessCentralBaseAction

Constructors

constructor

new BusinessCentralBaseAction(): BusinessCentralBaseAction
Returns BusinessCentralBaseAction
Inherited from BaseAccountingAction.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)

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 BaseAccountingAction.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
- 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 BaseAccountingAction.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
- 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 BaseAccountingAction.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 BaseAccountingAction.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>
- 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 BaseAccountingAction.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 BaseAccountingAction.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 BaseAccountingAction.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 BaseAccountingAction.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 BaseAccountingAction.getParamValue
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:38

`Protected` `Abstract`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Override of the required abstract method from BaseAction
Parameters
- params: RunActionParams
Returns Promise<ActionResultSimple>
Inherited from BaseAccountingAction.InternalRunAction
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:33

`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>
- 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
- 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
- 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
- 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>
- 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 BaseAccountingAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

`Protected`validateAccountNumber

validateAccountNumber(accountNumber: string): boolean
Validates common accounting data formats
Parameters
- accountNumber: string
Returns boolean
Inherited from BaseAccountingAction.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 BaseAccountingAction.validateJournalEntryBalance
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:169

Class BusinessCentralBaseActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BusinessCentralBaseAction

Properties

ProtectedaccountingProvider

ProtectedapiVersion

ProtectedintegrationName

Protectedparams

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

Protected AbstractInternalRunAction

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>

ProtectedvalidateAccountNumber

Parameters

Returns boolean

ProtectedvalidateJournalEntryBalance

Parameters

Returns boolean

Settings

Class BusinessCentralBaseAction`Abstract`

`Protected`accountingProvider

`Protected`apiVersion

`Protected`integrationName

`Protected`params

`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` `Abstract`InternalRunAction

`Protected`makeBCRequest

`Protected`mapAccountCategory

`Protected`mapAccountType

`Protected`parseBCDate

`Protected`queryBC

`Protected`validateAccountNumber

`Protected`validateJournalEntryBalance