quickbooks-api/dist/packages/api/credit-memo/credit-memo-api.d.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 { ApiClient } from '../api-client.js';
import { type CreditMemo } from '../../../types/types.js';
import { CreditMemoQueryBuilder } from './credit-memo-query-builder.js';
/**
 * API Client
 */
export declare class CreditMemoAPI {
    protected readonly apiClient: ApiClient;
    readonly getAllCreditMemos: (options?: import("../../../app.js").CreditMemoOptions | undefined) => Promise<import("../../../app.js").SearchResponse<CreditMemo>>;
    readonly getCreditMemoById: (id: string, options?: import("../../../app.js").CreditMemoOptions | undefined) => Promise<CreditMemo | null>;
    readonly getCreditMemosForDateRange: (startDate: Date, endDate: Date, options?: import("../../../app.js").CreditMemoOptions | undefined) => Promise<import("../../../app.js").SearchResponse<CreditMemo>>;
    readonly getUpdatedCreditMemos: (lastUpdatedDate: Date, options?: import("../../../app.js").CreditMemoOptions | undefined) => Promise<import("../../../app.js").SearchResponse<CreditMemo>>;
    readonly rawCreditMemoQuery: (queryBuilder: CreditMemoQueryBuilder) => Promise<import("../../../app.js").SearchResponse<CreditMemo>>;
    /**
     * Constructor

     * @param apiClient - The API Client
     */
    constructor(apiClient: ApiClient);
    /**
     * Get the Company Endpoint
     * @returns The Company Endpoint with the attached token realmId
     */
    protected getCompanyEndpoint(): Promise<string>;
    /**
     * Format the Response
     * @param response - The Response
     * @returns The CreditMemos
     */
    protected formatResponse(response: any): Array<CreditMemo>;
    /**
     * Get the Query Builder
     * @returns The Query Builder
     */
    getQueryBuilder(): Promise<CreditMemoQueryBuilder>;
    /**
     * Checks if there is a next page
     * @param queryBuilder - The Query Builder
     * @returns {boolean} True if there is a next page, false otherwise
     */
    protected hasNextPage(queryBuilder: CreditMemoQueryBuilder): Promise<boolean>;
}