conductor-node 14.9.0 → 14.11.0

package/src/resources/qbd/bills.ts

@@ -62,6 +62,10 @@ export class Bills extends APIResource {
    * you must continue to supply the vendor, accounts payable account, and at least
    * one expense or item line when you resubmit the bill.
    *
+   * **NOTE:** If you include `expenseLines`, `itemLines`, or `itemGroupLines`,
+   * QuickBooks Desktop replaces each included line list with the array you send, so
+   * include unchanged lines you want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const bill = await conductor.qbd.bills.update(
@@ -124,6 +128,27 @@ export class Bills extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a bill by setting its amount to zero while keeping a record of it in
+   * QuickBooks. The void will fail if the bill is currently in use or has any linked
+   * transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.bills.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(id: string, params: BillVoidParams, options?: RequestOptions): APIPromise<BillVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/bills/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type BillsCursorPage = CursorPage<Bill>;
@@ -1709,6 +1734,42 @@ export interface BillDeleteResponse {
   refNumber: string | null;
 }
 
+export interface BillVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided bill.
+   */
+  id: string;
+
+  /**
+   * The date and time when this bill was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_bill"`.
+   */
+  objectType: 'qbd_bill';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided bill.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this bill was last updated, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the bill was voided.
+   */
+  voided: boolean;
+}
+
 export interface BillCreateParams {
   /**
    * Body param: The date of this bill, in ISO 8601 format (YYYY-MM-DD).
@@ -3106,15 +3167,24 @@ export interface BillDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface BillVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace Bills {
   export {
     type Bill as Bill,
     type BillDeleteResponse as BillDeleteResponse,
+    type BillVoidResponse as BillVoidResponse,
     type BillsCursorPage as BillsCursorPage,
     type BillCreateParams as BillCreateParams,
     type BillRetrieveParams as BillRetrieveParams,
     type BillUpdateParams as BillUpdateParams,
     type BillListParams as BillListParams,
     type BillDeleteParams as BillDeleteParams,
+    type BillVoidParams as BillVoidParams,
   };
 }

package/src/resources/qbd/checks.ts

@@ -61,6 +61,10 @@ export class Checks extends APIResource {
    * memo, transaction date, or expense and item lines. This request cannot modify
    * checks created through the bill-payment workflow.
    *
+   * **NOTE:** If you include `expenseLines`, `itemLines`, or `itemGroupLines`,
+   * QuickBooks Desktop replaces each included line list with the array you send, so
+   * include unchanged lines you want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const check = await conductor.qbd.checks.update(
@@ -123,6 +127,27 @@ export class Checks extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a check by setting its amount to zero while keeping a record of it in
+   * QuickBooks. The void will fail if the check is currently in use or has any
+   * linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.checks.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(id: string, params: CheckVoidParams, options?: RequestOptions): APIPromise<CheckVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/checks/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type ChecksCursorPage = CursorPage<Check>;
@@ -1659,6 +1684,42 @@ export interface CheckDeleteResponse {
   refNumber: string | null;
 }
 
+export interface CheckVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided check.
+   */
+  id: string;
+
+  /**
+   * The date and time when this check was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_check"`.
+   */
+  objectType: 'qbd_check';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided check.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this check was last updated, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the check was voided.
+   */
+  voided: boolean;
+}
+
 export interface CheckCreateParams {
   /**
    * Body param: The bank account from which the funds are being drawn for this
@@ -3068,15 +3129,24 @@ export interface CheckDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface CheckVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace Checks {
   export {
     type Check as Check,
     type CheckDeleteResponse as CheckDeleteResponse,
+    type CheckVoidResponse as CheckVoidResponse,
     type ChecksCursorPage as ChecksCursorPage,
     type CheckCreateParams as CheckCreateParams,
     type CheckRetrieveParams as CheckRetrieveParams,
     type CheckUpdateParams as CheckUpdateParams,
     type CheckListParams as CheckListParams,
     type CheckDeleteParams as CheckDeleteParams,
+    type CheckVoidParams as CheckVoidParams,
   };
 }

package/src/resources/qbd/classes.ts

@@ -74,9 +74,10 @@ export class Classes extends APIResource {
   }
 
   /**
-   * Returns a list of classes. NOTE: QuickBooks Desktop does not support pagination
-   * for classes; hence, there is no `cursor` parameter. Users typically have few
-   * classes.
+   * Returns a list of classes.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for classes; hence,
+   * there is no `cursor` parameter. Users typically have few classes.
    *
    * @example
    * ```ts

package/src/resources/qbd/credit-card-charges.ts

@@ -64,6 +64,10 @@ export class CreditCardCharges extends APIResource {
    * account, payee, memo, transaction date, and expense or item lines. The total is
    * recalculated from the line details.
    *
+   * **NOTE:** If you include `expenseLines`, `itemLines`, or `itemGroupLines`,
+   * QuickBooks Desktop replaces each included line list with the array you send, so
+   * include unchanged lines you want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const creditCardCharge =
@@ -139,6 +143,31 @@ export class CreditCardCharges extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a credit card charge by setting its amount to zero while keeping a record
+   * of it in QuickBooks. The void will fail if the credit card charge is currently
+   * in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.creditCardCharges.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(
+    id: string,
+    params: CreditCardChargeVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditCardChargeVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/credit-card-charges/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type CreditCardChargesCursorPage = CursorPage<CreditCardCharge>;
@@ -1523,6 +1552,43 @@ export interface CreditCardChargeDeleteResponse {
   refNumber: string | null;
 }
 
+export interface CreditCardChargeVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided credit card charge.
+   */
+  id: string;
+
+  /**
+   * The date and time when this credit card charge was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_credit_card_charge"`.
+   */
+  objectType: 'qbd_credit_card_charge';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided credit card
+   * charge.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this credit card charge was last updated, in ISO 8601
+   * format (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the
+   * local timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the credit card charge was voided.
+   */
+  voided: boolean;
+}
+
 export interface CreditCardChargeCreateParams {
   /**
    * Body param: The bank or credit card account to which money is owed for this
@@ -2710,15 +2776,24 @@ export interface CreditCardChargeDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface CreditCardChargeVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace CreditCardCharges {
   export {
     type CreditCardCharge as CreditCardCharge,
     type CreditCardChargeDeleteResponse as CreditCardChargeDeleteResponse,
+    type CreditCardChargeVoidResponse as CreditCardChargeVoidResponse,
     type CreditCardChargesCursorPage as CreditCardChargesCursorPage,
     type CreditCardChargeCreateParams as CreditCardChargeCreateParams,
     type CreditCardChargeRetrieveParams as CreditCardChargeRetrieveParams,
     type CreditCardChargeUpdateParams as CreditCardChargeUpdateParams,
     type CreditCardChargeListParams as CreditCardChargeListParams,
     type CreditCardChargeDeleteParams as CreditCardChargeDeleteParams,
+    type CreditCardChargeVoidParams as CreditCardChargeVoidParams,
   };
 }

package/src/resources/qbd/credit-card-credits.ts

@@ -62,6 +62,10 @@ export class CreditCardCredits extends APIResource {
   /**
    * Updates an existing credit card credit.
    *
+   * **NOTE:** If you include `expenseLines`, `itemLines`, or `itemGroupLines`,
+   * QuickBooks Desktop replaces each included line list with the array you send, so
+   * include unchanged lines you want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const creditCardCredit =
@@ -137,6 +141,31 @@ export class CreditCardCredits extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a credit card credit by setting its amount to zero while keeping a record
+   * of it in QuickBooks. The void will fail if the credit card credit is currently
+   * in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.creditCardCredits.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(
+    id: string,
+    params: CreditCardCreditVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditCardCreditVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/credit-card-credits/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type CreditCardCreditsCursorPage = CursorPage<CreditCardCredit>;
@@ -1519,6 +1548,43 @@ export interface CreditCardCreditDeleteResponse {
   refNumber: string | null;
 }
 
+export interface CreditCardCreditVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided credit card credit.
+   */
+  id: string;
+
+  /**
+   * The date and time when this credit card credit was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_credit_card_credit"`.
+   */
+  objectType: 'qbd_credit_card_credit';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided credit card
+   * credit.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this credit card credit was last updated, in ISO 8601
+   * format (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the
+   * local timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the credit card credit was voided.
+   */
+  voided: boolean;
+}
+
 export interface CreditCardCreditCreateParams {
   /**
    * Body param: The bank or credit card account to which this credit card credit is
@@ -2705,15 +2771,24 @@ export interface CreditCardCreditDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface CreditCardCreditVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace CreditCardCredits {
   export {
     type CreditCardCredit as CreditCardCredit,
     type CreditCardCreditDeleteResponse as CreditCardCreditDeleteResponse,
+    type CreditCardCreditVoidResponse as CreditCardCreditVoidResponse,
     type CreditCardCreditsCursorPage as CreditCardCreditsCursorPage,
     type CreditCardCreditCreateParams as CreditCardCreditCreateParams,
     type CreditCardCreditRetrieveParams as CreditCardCreditRetrieveParams,
     type CreditCardCreditUpdateParams as CreditCardCreditUpdateParams,
     type CreditCardCreditListParams as CreditCardCreditListParams,
     type CreditCardCreditDeleteParams as CreditCardCreditDeleteParams,
+    type CreditCardCreditVoidParams as CreditCardCreditVoidParams,
   };
 }

package/src/resources/qbd/credit-card-refunds.ts

@@ -118,6 +118,31 @@ export class CreditCardRefunds extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a credit card refund by setting its amount to zero while keeping a record
+   * of it in QuickBooks. The void will fail if the credit card refund is currently
+   * in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.creditCardRefunds.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(
+    id: string,
+    params: CreditCardRefundVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditCardRefundVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/credit-card-refunds/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type CreditCardRefundsCursorPage = CursorPage<CreditCardRefund>;
@@ -724,6 +749,43 @@ export interface CreditCardRefundDeleteResponse {
   refNumber: string | null;
 }
 
+export interface CreditCardRefundVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided credit card refund.
+   */
+  id: string;
+
+  /**
+   * The date and time when this credit card refund was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_credit_card_refund"`.
+   */
+  objectType: 'qbd_credit_card_refund';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided credit card
+   * refund.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this credit card refund was last updated, in ISO 8601
+   * format (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the
+   * local timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the credit card refund was voided.
+   */
+  voided: boolean;
+}
+
 export interface CreditCardRefundCreateParams {
   /**
    * Body param: The customer or customer-job associated with this credit card
@@ -1238,14 +1300,23 @@ export interface CreditCardRefundDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface CreditCardRefundVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace CreditCardRefunds {
   export {
     type CreditCardRefund as CreditCardRefund,
     type CreditCardRefundDeleteResponse as CreditCardRefundDeleteResponse,
+    type CreditCardRefundVoidResponse as CreditCardRefundVoidResponse,
     type CreditCardRefundsCursorPage as CreditCardRefundsCursorPage,
     type CreditCardRefundCreateParams as CreditCardRefundCreateParams,
     type CreditCardRefundRetrieveParams as CreditCardRefundRetrieveParams,
     type CreditCardRefundListParams as CreditCardRefundListParams,
     type CreditCardRefundDeleteParams as CreditCardRefundDeleteParams,
+    type CreditCardRefundVoidParams as CreditCardRefundVoidParams,
   };
 }

package/src/resources/qbd/credit-memos.ts

@@ -57,6 +57,10 @@ export class CreditMemos extends APIResource {
   /**
    * Updates an existing credit memo.
    *
+   * **NOTE:** If you include `lines` or `lineGroups`, QuickBooks Desktop replaces
+   * each included line list with the array you send, so include unchanged lines you
+   * want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const creditMemo = await conductor.qbd.creditMemos.update(
@@ -126,6 +130,31 @@ export class CreditMemos extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a credit memo by setting its amount to zero while keeping a record of it
+   * in QuickBooks. The void will fail if the credit memo is currently in use or has
+   * any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.creditMemos.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(
+    id: string,
+    params: CreditMemoVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditMemoVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/credit-memos/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type CreditMemosCursorPage = CursorPage<CreditMemo>;
@@ -1724,6 +1753,42 @@ export interface CreditMemoDeleteResponse {
   refNumber: string | null;
 }
 
+export interface CreditMemoVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided credit memo.
+   */
+  id: string;
+
+  /**
+   * The date and time when this credit memo was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_credit_memo"`.
+   */
+  objectType: 'qbd_credit_memo';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided credit memo.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this credit memo was last updated, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the credit memo was voided.
+   */
+  voided: boolean;
+}
+
 export interface CreditMemoCreateParams {
   /**
    * Body param: The customer or customer-job associated with this credit memo.
@@ -3220,15 +3285,24 @@ export interface CreditMemoDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface CreditMemoVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace CreditMemos {
   export {
     type CreditMemo as CreditMemo,
     type CreditMemoDeleteResponse as CreditMemoDeleteResponse,
+    type CreditMemoVoidResponse as CreditMemoVoidResponse,
     type CreditMemosCursorPage as CreditMemosCursorPage,
     type CreditMemoCreateParams as CreditMemoCreateParams,
     type CreditMemoRetrieveParams as CreditMemoRetrieveParams,
     type CreditMemoUpdateParams as CreditMemoUpdateParams,
     type CreditMemoListParams as CreditMemoListParams,
     type CreditMemoDeleteParams as CreditMemoDeleteParams,
+    type CreditMemoVoidParams as CreditMemoVoidParams,
   };
 }

package/src/resources/qbd/currencies.ts

@@ -79,9 +79,10 @@ export class Currencies extends APIResource {
   }
 
   /**
-   * Returns a list of currencies. NOTE: QuickBooks Desktop does not support
-   * pagination for currencies; hence, there is no `cursor` parameter. Users
-   * typically have few currencies.
+   * Returns a list of currencies.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for currencies; hence,
+   * there is no `cursor` parameter. Users typically have few currencies.
    *
    * @example
    * ```ts

package/src/resources/qbd/customer-types.ts

@@ -57,9 +57,10 @@ export class CustomerTypes extends APIResource {
   }
 
   /**
-   * Returns a list of customer types. NOTE: QuickBooks Desktop does not support
-   * pagination for customer types; hence, there is no `cursor` parameter. Users
-   * typically have few customer types.
+   * Returns a list of customer types.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for customer types;
+   * hence, there is no `cursor` parameter. Users typically have few customer types.
    *
    * @example
    * ```ts