quickbooks-api/dist/packages/api/customer/services/get-updated-customers.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.

// Import the Query Builder
import { plainToClass } from 'class-transformer';
import { Customer } from '../../../../types/types.js';
/**
 * Retrieves updated customer records modified after the specified cutoff date.
 *
 * This function constructs a query to filter customers updated after the given date, applies
 * any provided search options, builds the request URL, and executes a GET request to fetch the data.
 * The API response is then formatted into a search response object containing the list of customers
 * and a flag indicating whether additional pages of results are available.
 *
 * @param lastUpdatedDate - The cutoff date; only customers updated after this date are returned.
 * @param options - Optional search parameters to refine the query.
 * @returns A promise that resolves to a search response with the updated customer records and pagination information.
 */
export async function getUpdatedCustomers(lastUpdatedDate, options = {}) {
    // Get the Query Builder
    const queryBuilder = await this.getQueryBuilder();
    // Setup the Last Updated Date Filter
    queryBuilder.whereLastUpdatedAfter(lastUpdatedDate);
    // Setup the Search Options (if provided)
    if (options.searchOptions)
        queryBuilder.setSearchOptions(options.searchOptions);
    // Setup the URL
    const url = queryBuilder.build();
    // Get the Customers
    const response = await this.apiClient.runRequest(url, { method: 'GET' });
    // Format the Response
    const customers = this.formatResponse(response);
    // Map the Customers to Classes
    const mappedCustomers = customers.map((customer) => plainToClass(Customer, customer));
    // Setup the Search Response
    const searchResponse = {
        results: mappedCustomers,
        hasNextPage: await this.hasNextPage(queryBuilder),
    };
    // Return the Customers
    return searchResponse;
}