conductor-node 14.24.2 → 14.24.4

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

@@ -1922,6 +1922,8 @@ export interface CreditMemoCreateParams {
   /**
    * Body param: A memo or note for this credit memo that appears in the account
    * register and customer register, but not on the credit memo itself.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -1933,6 +1935,8 @@ export interface CreditMemoCreateParams {
    * other standard QuickBooks fields. Unlike `otherCustomField1` and
    * `otherCustomField2`, which are line item fields, this exists at the transaction
    * level. Hidden by default in the QuickBooks UI.
+   *
+   * Maximum length: 29 characters.
    */
   otherCustomField?: string;
 
@@ -2041,6 +2045,8 @@ export namespace CreditMemoCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2083,6 +2089,8 @@ export namespace CreditMemoCreateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -2146,6 +2154,8 @@ export namespace CreditMemoCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this credit memo line group. Must
      * be a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2155,6 +2165,8 @@ export namespace CreditMemoCreateParams {
       /**
        * The name of the custom field, unique for the specified `ownerId`. For public
        * custom fields, this name is visible as a label in the QuickBooks UI.
+       *
+       * Maximum length: 31 characters.
        */
       name: string;
 
@@ -2207,6 +2219,8 @@ export namespace CreditMemoCreateParams {
 
     /**
      * A description of this credit memo line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2233,6 +2247,8 @@ export namespace CreditMemoCreateParams {
     /**
      * The lot number of the item associated with this credit memo line. Used for
      * tracking groups of inventory items that are purchased or manufactured together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -2242,6 +2258,8 @@ export namespace CreditMemoCreateParams {
      * standard QuickBooks field that exists for all credit memo lines for convenience.
      * Developers often use this field for tracking information that doesn't fit into
      * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField1?: string;
 
@@ -2252,6 +2270,8 @@ export namespace CreditMemoCreateParams {
      * convenience. Like `otherCustomField1`, developers often use this field for
      * tracking information that doesn't fit into other standard QuickBooks fields.
      * Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField2?: string;
 
@@ -2309,6 +2329,8 @@ export namespace CreditMemoCreateParams {
     /**
      * The serial number of the item associated with this credit memo line. This is
      * used for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -2322,6 +2344,8 @@ export namespace CreditMemoCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this credit memo line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2331,6 +2355,8 @@ export namespace CreditMemoCreateParams {
       /**
        * The name of the custom field, unique for the specified `ownerId`. For public
        * custom fields, this name is visible as a label in the QuickBooks UI.
+       *
+       * Maximum length: 31 characters.
        */
       name: string;
 
@@ -2366,6 +2392,8 @@ export namespace CreditMemoCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2408,6 +2436,8 @@ export namespace CreditMemoCreateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -2548,6 +2578,8 @@ export interface CreditMemoUpdateParams {
   /**
    * Body param: A memo or note for this credit memo that appears in the account
    * register and customer register, but not on the credit memo itself.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -2559,6 +2591,8 @@ export interface CreditMemoUpdateParams {
    * other standard QuickBooks fields. Unlike `otherCustomField1` and
    * `otherCustomField2`, which are line item fields, this exists at the transaction
    * level. Hidden by default in the QuickBooks UI.
+   *
+   * Maximum length: 29 characters.
    */
   otherCustomField?: string;
 
@@ -2670,6 +2704,8 @@ export namespace CreditMemoUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2712,6 +2748,8 @@ export namespace CreditMemoUpdateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -2792,6 +2830,8 @@ export namespace CreditMemoUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this credit memo line group. Must
      * be a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2829,6 +2869,8 @@ export namespace CreditMemoUpdateParams {
 
       /**
        * A description of this credit memo line.
+       *
+       * Maximum length: 4095 characters.
        */
       description?: string;
 
@@ -2855,6 +2897,8 @@ export namespace CreditMemoUpdateParams {
       /**
        * The lot number of the item associated with this credit memo line. Used for
        * tracking groups of inventory items that are purchased or manufactured together.
+       *
+       * Maximum length: 40 characters.
        */
       lotNumber?: string;
 
@@ -2864,6 +2908,8 @@ export namespace CreditMemoUpdateParams {
        * standard QuickBooks field that exists for all credit memo lines for convenience.
        * Developers often use this field for tracking information that doesn't fit into
        * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
+       *
+       * Maximum length: 29 characters.
        */
       otherCustomField1?: string;
 
@@ -2874,6 +2920,8 @@ export namespace CreditMemoUpdateParams {
        * convenience. Like `otherCustomField1`, developers often use this field for
        * tracking information that doesn't fit into other standard QuickBooks fields.
        * Hidden by default in the QuickBooks UI.
+       *
+       * Maximum length: 29 characters.
        */
       otherCustomField2?: string;
 
@@ -2946,6 +2994,8 @@ export namespace CreditMemoUpdateParams {
       /**
        * The serial number of the item associated with this credit memo line. This is
        * used for tracking individual units of serialized inventory items.
+       *
+       * Maximum length: 4095 characters.
        */
       serialNumber?: string;
 
@@ -2959,6 +3009,8 @@ export namespace CreditMemoUpdateParams {
       /**
        * The unit-of-measure used for the `quantity` in this credit memo line. Must be a
        * valid unit within the item's available units of measure.
+       *
+       * Maximum length: 31 characters.
        */
       unitOfMeasure?: string;
     }
@@ -2996,6 +3048,8 @@ export namespace CreditMemoUpdateParams {
 
     /**
      * A description of this credit memo line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -3022,6 +3076,8 @@ export namespace CreditMemoUpdateParams {
     /**
      * The lot number of the item associated with this credit memo line. Used for
      * tracking groups of inventory items that are purchased or manufactured together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -3031,6 +3087,8 @@ export namespace CreditMemoUpdateParams {
      * standard QuickBooks field that exists for all credit memo lines for convenience.
      * Developers often use this field for tracking information that doesn't fit into
      * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField1?: string;
 
@@ -3041,6 +3099,8 @@ export namespace CreditMemoUpdateParams {
      * convenience. Like `otherCustomField1`, developers often use this field for
      * tracking information that doesn't fit into other standard QuickBooks fields.
      * Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField2?: string;
 
@@ -3113,6 +3173,8 @@ export namespace CreditMemoUpdateParams {
     /**
      * The serial number of the item associated with this credit memo line. This is
      * used for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -3126,6 +3188,8 @@ export namespace CreditMemoUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this credit memo line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -3143,6 +3207,8 @@ export namespace CreditMemoUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -3185,6 +3251,8 @@ export namespace CreditMemoUpdateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -3270,6 +3338,9 @@ export interface CreditMemoListParams extends CursorPageParams {
    * to this value. If omitted, the range will begin with the first number of the
    * list. Uses a numerical comparison for values that contain only digits;
    * otherwise, uses a lexicographical comparison.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `refNumberContains`,
+   * `refNumberStartsWith`, or `refNumberEndsWith`.
    */
   refNumberFrom?: string;
 
@@ -3300,6 +3371,9 @@ export interface CreditMemoListParams extends CursorPageParams {
    * this value. If omitted, the range will end with the last number of the list.
    * Uses a numerical comparison for values that contain only digits; otherwise, uses
    * a lexicographical comparison.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `refNumberContains`,
+   * `refNumberStartsWith`, or `refNumberEndsWith`.
    */
   refNumberTo?: string;
 

package/src/resources/qbd/currencies.ts

@@ -426,13 +426,10 @@ export interface CurrencyListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * currencies. This parameter will limit the response size, but you cannot fetch
-   * subsequent results using a cursor. For pagination, use the name-range parameters
-   * instead (e.g., `nameFrom=A&nameTo=B`).
+   * currencies, so this parameter only limits the response size.
    *
    * When this parameter is omitted, the endpoint returns all currencies without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because currencies typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -455,8 +452,12 @@ export interface CurrencyListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for currencies whose `name` is alphabetically greater than
-   * or equal to this value.
+   * Query param: Filter for currencies whose `name` sorts at or after this value
+   * (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
+   * first, then digits, then letters.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameFrom?: string;
 
@@ -482,8 +483,13 @@ export interface CurrencyListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for currencies whose `name` is alphabetically less than or
-   * equal to this value.
+   * Query param: Filter for currencies whose `name` sorts at or before this value
+   * (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
+   * first, then digits, then letters. If you also set `nameFrom`, it must not sort
+   * after this value, or QuickBooks returns an error.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameTo?: string;
 

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

@@ -276,13 +276,12 @@ export interface CustomerTypeListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * customer types. This parameter will limit the response size, but you cannot
-   * fetch subsequent results using a cursor. For pagination, use the name-range
-   * parameters instead (e.g., `nameFrom=A&nameTo=B`).
+   * customer types, so this parameter only limits the response size. To page through
+   * customer types by name, see
+   * [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
    *
    * When this parameter is omitted, the endpoint returns all customer types without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because customer types typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -305,8 +304,17 @@ export interface CustomerTypeListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for customer types whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for customer types whose `fullName` sorts at or after this
+   * value (inclusive), compared case-insensitively in QuickBooks' sort order:
+   * punctuation first, then digits, then letters.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns customer types sorted by
+   * `fullName` in that order; without either, the order is not guaranteed. To page
+   * through customer types by name, see
+   * [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameFrom?: string;
 
@@ -320,8 +328,16 @@ export interface CustomerTypeListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for customer types whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for customer types whose `fullName` sorts at or before this
+   * value (inclusive), compared case-insensitively in QuickBooks' sort order:
+   * punctuation first, then digits, then letters. If you also set `nameFrom`, it
+   * must not sort after this value, or QuickBooks returns an error.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns customer types sorted by
+   * `fullName` in that order; without either, the order is not guaranteed.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameTo?: string;