quickbooks-api/src/packages/api/estimates/services/get-estimate-by-id.ts

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.

// Import the Query Builder
import { plainToClass } from 'class-transformer';
import { Estimate, type EstimateOptions } from '../../../../types/types';
import { EstimateAPI } from '../estimate-api';

/**
 * Get Estimate by ID
 * @param this - The Estimate API
 * @param id - The ID of the estimate
 * @returns The Estimate
 */
export async function getEstimateById(
	this: EstimateAPI,
	id: string,
	options: EstimateOptions = {},
): Promise<{ estimate: Estimate | null; intuitTID: string }> {
	// Get the Query Builder
	const queryBuilder = await this.getQueryBuilder();

	// Setup ID Filter
	queryBuilder.whereId(id);

	// Setup the Search Options (if provided)
	if (options.searchOptions) queryBuilder.setSearchOptions(options.searchOptions);

	// Setup the URL
	const url = queryBuilder.build();

	// Get the Estimate
	const { responseData, intuitTID } = await this.apiClient.runRequest(url, { method: 'GET' });

	// Check if the Response Failed to find an Estimate
	if (!responseData) return { estimate: null, intuitTID };

	// Format the Response
	const estimates = await this.formatResponse(responseData);

	// Convert the Estimate to a Class
	const estimate = estimates[0] ? plainToClass(Estimate, estimates[0]) : null;

	// Check if the Estimate is valid and set the API Client
	if (estimate) estimate.setApiClient(this.apiClient);

	// Return the Estimate with Intuit TID
	return {
		estimate,
		intuitTID,
	};
}