quickbooks-api/src/packages/api/payment/services/get-payments-for-date-range.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 { QuickbooksError, type Payment, type PaymentOptions, type SearchResponse } from '../../../../types/types';
import { PaymentAPI } from '../payment-api';
import { ApiClient } from '../../api-client';

/**
 * Get Payments for a Date Range
 * @param this - The Payment API
 * @param startDate - The start date
 * @param endDate - The end date
 * @returns The Payments
 */
export async function getPaymentsForDateRange(
	this: PaymentAPI,
	startDate: Date,
	endDate: Date,
	options: PaymentOptions = {},
): Promise<SearchResponse<Payment>> {
	// Ensure the Start Date is Before the End Date
	if (startDate > endDate) throw new QuickbooksError('Start date must be before end date', await ApiClient.getIntuitErrorDetails(null));

	// Get the Query Builder
	const queryBuilder = await this.getQueryBuilder();

	// Setup the Date Range Filters
	queryBuilder.whereLastUpdatedAfter(startDate);
	queryBuilder.whereLastUpdatedBefore(endDate);

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

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

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

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

	// Setup the Search Response
	const searchResponse: SearchResponse<Payment> = {
		results: payments,
		hasNextPage: await this.hasNextPage(queryBuilder),
		intuitTID,
	};

	// Return the Payments
	return searchResponse;
}