quickbooks-api/src/packages/api/payment/payment-api.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.

// Imports
import { ApiClient } from '../api-client';
import { Environment, Query, QuickbooksError, type Payment, type PaymentQueryResponse } from '../../../types/types';
import { Endpoints } from '../../../types/enums/endpoints';
import { PaymentQueryBuilder } from './payment-query-builder';
import path from 'path';

// Import the Services
import { getAllPayments } from './services/get-all-payments';
import { getPaymentById } from './services/get-payment-by-id';
import { getPaymentsForDateRange } from './services/get-payments-for-date-range';
import { getUpdatedPayments } from './services/get-updated-payments';
import { getPaymentsByDueDate } from './services/get-payment-by-due-date';
import { rawPaymentQuery } from './services/raw-payment-query';

/**
 * API Client
 */
export class PaymentAPI {
	// The List of Payment Services
	public readonly getAllPayments = getAllPayments.bind(this);
	public readonly getPaymentById = getPaymentById.bind(this);
	public readonly getPaymentsForDateRange = getPaymentsForDateRange.bind(this);
	public readonly getUpdatedPayments = getUpdatedPayments.bind(this);
	public readonly getPaymentsByDueDate = getPaymentsByDueDate.bind(this);
	public readonly rawPaymentQuery = rawPaymentQuery.bind(this);

	/**
	 * Constructor

	 * @param apiClient - The API Client
	 */
	constructor(protected readonly apiClient: ApiClient) {}

	/**
	 * Get the Company Endpoint
	 * @returns The Company Endpoint with the attached token realmId
	 */
	protected async getCompanyEndpoint() {
		// Get the Base Endpoint
		const baseEndpoint =
			this.apiClient.environment === Environment.Production ? Endpoints.ProductionCompanyApi : Endpoints.SandboxCompanyApi;

		// Get the Token
		const token = await this.apiClient.authProvider.getToken();

		// Return the Company Endpoint
		return `${baseEndpoint}/${token.realmId}`;
	}

	/**
	 * Format the Response
	 * @param response - The Response
	 * @returns The Payments
	 */
	protected async formatResponse(response: any): Promise<Array<Payment>> {
		// Check if the Response is Invalid
		if (!response?.QueryResponse) {
			// Get the Intuit Error Details
			const errorDetails = await ApiClient.getIntuitErrorDetails(response);

			// Throw the Quickbooks Error
			throw new QuickbooksError('Unable to format Payments', errorDetails);
		}

		// Check if the Payment is Not set and if it is, set the Payment to an empty array
		if (!response.QueryResponse.Payment) response.QueryResponse.Payment = new Array();

		// Get the Payments
		const queryResponse = response.QueryResponse as PaymentQueryResponse;

		// Return the Payments
		return queryResponse.Payment;
	}

	// Returns the Payment URL
	public async getUrl() {
		// Setup the URL
		const url = new URL(await this.getCompanyEndpoint());

		// Set the Payment Endpoint
		url.pathname = path.join(url.pathname, 'payment');

		// Return the URL
		return url;
	}

	/**
	 * Get the Query Builder
	 * @returns The Query Builder
	 */
	public async getQueryBuilder(): Promise<PaymentQueryBuilder> {
		// Get the Company Endpoint
		const companyEndpoint = await this.getCompanyEndpoint();

		// Setup the New Query Builder
		const queryBuilder = new PaymentQueryBuilder(companyEndpoint, Query.Payment);

		// Return the Query Builder
		return queryBuilder;
	}

	/**
	 * Checks if there is a next page
	 * @param queryBuilder - The Query Builder
	 * @returns {boolean} True if there is a next page, false otherwise
	 */
	protected async hasNextPage(queryBuilder: PaymentQueryBuilder): Promise<boolean> {
		// Check if the Auto Check Next Page is Disabled
		if (!this.apiClient.autoCheckNextPage) return false;

		// Get the Page Number
		const page = (queryBuilder.searchOptions.page || 1) + 1;

		// Update the Page Number
		queryBuilder.searchOptions.page = page;

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

		// Run the Request
		const result = await this.apiClient.runRequest(url, { method: 'GET' }).catch((error) => {
			// Log the error
			console.error(`Failed to check if there is a next page: ${error}`);
			return null;
		});

		// Check if the Response is invalid
		if (!result?.responseData || !result.responseData?.QueryResponse?.Payment) return false;

		// Check if the Response is Invalid
		if (result.responseData.QueryResponse.Payment.length < 1) return false;

		// Return True
		return true;
	}
}