quickbooks-api/dist/packages/api/company-info/services/get-company-info.js

A modular TypeScript SDK for seamless integration with Intuit QuickBooks APIs. Provides robust authentication handling and future-ready foundation for accounting, payments, and commerce operations.

// Imports
import { plainToClass } from 'class-transformer';
import { CompanyInfo } from '../../../../types/types.js';
/**
 * Get Company Info
 * @param this - The Company Info API
 * @param options - The Search Options
 * @returns The Company Info
 */
export async function getCompanyInfo(options = {}) {
    // Get the Query Builder
    const queryBuilder = await this.getQueryBuilder();
    // Setup the Search Options (if provided)
    if (options.searchOptions)
        queryBuilder.setSearchOptions(options.searchOptions);
    // Setup the URL
    const url = queryBuilder.build();
    // Get the Company Info
    const { responseData, intuitTID } = await this.apiClient.runRequest(url, { method: 'GET' });
    // Format the Response
    const companyInfoData = await this.formatResponse(responseData);
    // Check if CompanyInfo data exists
    if (!companyInfoData)
        return { companyInfo: undefined, intuitTID };
    // Convert the CompanyInfo to a Class
    const companyInfo = plainToClass(CompanyInfo, companyInfoData);
    // Check if the conversion was successful
    if (!companyInfo)
        return { companyInfo: undefined, intuitTID };
    // Set the API Client
    companyInfo.setApiClient(this.apiClient);
    // Return the Company Info with Intuit TID
    return {
        companyInfo,
        intuitTID,
    };
}