Class BaseAccountingAction`Abstract`

Base class for all accounting-related actions. Provides common functionality and patterns for interacting with accounting systems.

Hierarchy (View Summary)

BaseAction
- BaseAccountingAction
  - QuickBooksBaseAction
  - BusinessCentralBaseAction

Index

Constructors

constructor

new BaseAccountingAction(): BaseAccountingAction
Returns BaseAccountingAction
Inherited from BaseAction.constructor

Properties

`Protected` `Abstract`accountingProvider

accountingProvider: string

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

`Protected` `Abstract`integrationName

integrationName: string

The integration name to look up in the Integration entity

`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.

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

`Protected`formatAccountingDate

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

`Protected`formatCurrency

formatCurrency(amount: number, currencyCode?: string): string
Formats currency values consistently
Parameters
- amount: number
- currencyCode: string = 'USD'
Returns string
- 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>
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:140

`Protected`getCommonAccountingParams

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

Returns ActionParam[]
- 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>
- 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
- 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 }>
- 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
- 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>
Overrides BaseAction.InternalRunAction
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:33

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

Class BaseAccountingActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseAccountingAction

Properties

Protected AbstractaccountingProvider

Protected AbstractintegrationName

Static ReadonlyAuthorizesCaller

Methods

ProtectedbuildAccountingErrorMessage

Parameters

Returns string

ProtectedformatAccountingDate

Parameters

Returns string

ProtectedformatCurrency

Parameters

Returns string

ProtectedgetAPIBaseURL

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>

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedvalidateAccountNumber

Parameters

Returns boolean

ProtectedvalidateJournalEntryBalance

Parameters

Returns boolean

Settings

On This Page

Class BaseAccountingAction`Abstract`

`Protected` `Abstract`accountingProvider

`Protected` `Abstract`integrationName

`Static` `Readonly`AuthorizesCaller

`Protected`buildAccountingErrorMessage

`Protected`formatAccountingDate

`Protected`formatCurrency

`Protected`getAPIBaseURL

`Protected`getCommonAccountingParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getOAuthTokens

`Protected`getParamValue

`Protected` `Abstract`InternalRunAction

`Protected`validateAccountNumber

`Protected`validateJournalEntryBalance