Class GetQuickBooksDimensionsAction

ProtectedaccountingProvider

ProtectedapiVersion

ProtectedintegrationName

ProtectedminorVersion

ProtectedbuildAccountingErrorMessage

• 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

ProtecteddispatchVerb

• dispatchVerb(verb: string, params: RunActionParams): Promise<ActionResultSimple>

  Resolve the company's ERP and invoke the plugin registered as ${verb}:${integration.Name}. Plugin.Run → InternalRunAction with the same params the caller passed to the dispatcher.

  Parameters

  • verb: string
  • params: RunActionParams

  Returns Promise<ActionResultSimple>

ProtectedformatAccountingDate

• formatAccountingDate(date: Date): string

  Standard date format for accounting systems (ISO 8601)

  Parameters

  • date: Date

  Returns string

ProtectedformatCurrency

• formatCurrency(amount: number, currencyCode?: string): string

  Formats currency values consistently

  Parameters

  • amount: number
  • currencyCode: string = 'USD'

  Returns string

ProtectedformatQBODate

• formatQBODate(date: Date): string

  Formats date for QuickBooks API

  Parameters

  • date: Date

  Returns string

ProtectedgetAPIBaseURL

• 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>

ProtectedgetCommonAccountingParams

• getCommonAccountingParams(): ActionParam[]

  Common accounting parameters that many actions will need

  Returns ActionParam[]

ProtectedgetCompanyIntegration

• 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>

ProtectedgetCredentialFromEnv

• 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

ProtectedgetOAuthTokens

• 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 }>

ProtectedgetParamValue

• getParamValue(params: ActionParam[], name: string): any

  Helper to get a parameter value from the params array

  Parameters

  • params: ActionParam[]
  • name: string

  Returns any

ProtectedgetQuickBooksAPIUrl

• getQuickBooksAPIUrl(integration: MJCompanyIntegrationEntity): Promise<string>

  Gets the appropriate QuickBooks API URL based on configuration

  Parameters

  • integration: MJCompanyIntegrationEntity

  Returns Promise<string>

ProtectedmakeQBORequest

• 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>

ProtectedmapAccountType

• mapAccountType(qboAccountType: string): string

  Maps QuickBooks account types to standard accounting categories

  Parameters

  • qboAccountType: string

  Returns string

ProtectedparseQBODate

• parseQBODate(qboDate: string): Date

  Converts QuickBooks date format to standard ISO format

  Parameters

  • qboDate: string

  Returns Date

ProtectedqueryQBO

• 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>

ProtectedresolveCompanyAccountingIntegration

• resolveCompanyAccountingIntegration(
      companyId: string,
      contextUser: UserInfo,
      integrationName?: string,
  ): Promise<ResolvedAccountingIntegration>

  Load the company's accounting CompanyIntegration (any Integration whose Name is one of the known ERP names). Does not hard-filter to a single vendor.

  Parameters

  • companyId: string
  • contextUser: UserInfo
  • OptionalintegrationName: string

  Returns Promise<ResolvedAccountingIntegration>

ProtectedvalidateAccountNumber

• validateAccountNumber(accountNumber: string): boolean

  Validates common accounting data formats

  Parameters

  • accountNumber: string

  Returns boolean

ProtectedvalidateJournalEntryBalance

• validateJournalEntryBalance(
      lines: { credit?: number; debit?: number }[],
  ): boolean

  Validates journal entry balance (debits must equal credits)

  Parameters

  • lines: { credit?: number; debit?: number }[]

  Returns boolean