Class GetQuickBooksAccountBalancesAction

Action to retrieve account balances (trial balance) from QuickBooks Online

Hierarchy (View Summary)

QuickBooksBaseAction
- GetQuickBooksAccountBalancesAction

Constructors

constructor

new GetQuickBooksAccountBalancesAction(): GetQuickBooksAccountBalancesAction
Returns GetQuickBooksAccountBalancesAction
Inherited from QuickBooksBaseAction.constructor

Properties

`Protected`accountingProvider

accountingProvider: string = 'QuickBooks Online'

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

`Protected`apiVersion

apiVersion: string = 'v3'

QuickBooks API version

`Protected`integrationName

integrationName: string = 'QuickBooks Online'

The integration name to look up in the Integration entity

`Protected`minorVersion

minorVersion: string = '65'

QuickBooks minor version for API compatibility

Accessors

Description

get Description(): string
Description of the action

Returns string
- Defined in BizApps/Accounting/src/providers/quickbooks/actions/get-account-balances.action.ts:47

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 QuickBooksBaseAction.buildAccountingErrorMessage
- 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
Inherited from QuickBooksBaseAction.formatAccountingDate
- 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
Inherited from QuickBooksBaseAction.formatCurrency
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:178

`Protected`formatQBODate

formatQBODate(date: Date): string
Formats date for QuickBooks API
Parameters
- date: Date
Returns string
Inherited from QuickBooksBaseAction.formatQBODate
- Defined in BizApps/Accounting/src/providers/quickbooks/quickbooks-base.action.ts:131

`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 QuickBooksBaseAction.getAPIBaseURL
- 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[]
Inherited from QuickBooksBaseAction.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 QuickBooksBaseAction.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 QuickBooksBaseAction.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 QuickBooksBaseAction.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 QuickBooksBaseAction.getParamValue
- Defined in BizApps/Accounting/src/base/base-accounting-action.ts:38

`Protected`getQuickBooksAPIUrl

getQuickBooksAPIUrl(integration: MJCompanyIntegrationEntity): Promise<string>
Gets the appropriate QuickBooks API URL based on configuration
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<string>
Inherited from QuickBooksBaseAction.getQuickBooksAPIUrl
- Defined in BizApps/Accounting/src/providers/quickbooks/quickbooks-base.action.ts:163

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Main execution method
Parameters
- params: RunActionParams
Returns Promise<ActionResultSimple>
Overrides QuickBooksBaseAction.InternalRunAction
- Defined in BizApps/Accounting/src/providers/quickbooks/actions/get-account-balances.action.ts:54

`Protected`makeQBORequest

makeQBORequest<T = any>(
    endpoint: string,
    method?: "GET" | "POST" | "PUT" | "DELETE",
    body?: any,
    contextUser?: UserInfo,
): Promise<T>
Makes an authenticated request to QuickBooks Online API
Type Parameters
- T = any
Parameters
- endpoint: string
- method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'
- Optionalbody: any
- OptionalcontextUser: UserInfo
Returns Promise<T>
Inherited from QuickBooksBaseAction.makeQBORequest
- Defined in BizApps/Accounting/src/providers/quickbooks/quickbooks-base.action.ts:30

`Protected`mapAccountType

mapAccountType(qboAccountType: string): string
Maps QuickBooks account types to standard accounting categories
Parameters
- qboAccountType: string
Returns string
Inherited from QuickBooksBaseAction.mapAccountType
- Defined in BizApps/Accounting/src/providers/quickbooks/quickbooks-base.action.ts:138

`Protected`parseQBODate

parseQBODate(qboDate: string): Date
Converts QuickBooks date format to standard ISO format
Parameters
- qboDate: string
Returns Date
Inherited from QuickBooksBaseAction.parseQBODate
- Defined in BizApps/Accounting/src/providers/quickbooks/quickbooks-base.action.ts:123

`Protected`queryQBO

queryQBO<T = any>(query: string, contextUser: UserInfo): Promise<T>
Handles QuickBooks query language requests
Type Parameters
- T = any
Parameters
- query: string
- contextUser: UserInfo
Returns Promise<T>
Inherited from QuickBooksBaseAction.queryQBO
- Defined in BizApps/Accounting/src/providers/quickbooks/quickbooks-base.action.ts:112

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

Class GetQuickBooksAccountBalancesAction

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GetQuickBooksAccountBalancesAction

Properties

ProtectedaccountingProvider

ProtectedapiVersion

ProtectedintegrationName

ProtectedminorVersion

Accessors

Description

Returns string

Methods

ProtectedbuildAccountingErrorMessage

Parameters

Returns string

ProtectedformatAccountingDate

Parameters

Returns string

ProtectedformatCurrency

Parameters

Returns string

ProtectedformatQBODate

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

ProtectedgetQuickBooksAPIUrl

Parameters

Returns Promise<string>

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedmakeQBORequest

Type Parameters

Parameters

Returns Promise<T>

ProtectedmapAccountType

Parameters

Returns string

ProtectedparseQBODate

Parameters

Returns Date

ProtectedqueryQBO

Type Parameters

Parameters

Returns Promise<T>

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedvalidateAccountNumber

Parameters

Returns boolean

ProtectedvalidateJournalEntryBalance

Parameters

Returns boolean

Settings

On This Page

`Protected`accountingProvider

`Protected`apiVersion

`Protected`integrationName

`Protected`minorVersion

`Protected`buildAccountingErrorMessage

`Protected`formatAccountingDate

`Protected`formatCurrency

`Protected`formatQBODate

`Protected`getAPIBaseURL

`Protected`getCommonAccountingParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getOAuthTokens

`Protected`getParamValue

`Protected`getQuickBooksAPIUrl

`Protected`InternalRunAction

`Protected`makeQBORequest

`Protected`mapAccountType

`Protected`parseQBODate

`Protected`queryQBO

`Protected`validateAccountNumber

`Protected`validateJournalEntryBalance