conductor-node 14.24.2 → 14.24.4

package/src/resources/qbd/sales-tax-group-items.ts

@@ -292,6 +292,8 @@ export interface SalesTaxGroupItemCreateParams {
   /**
    * Body param: The sales-tax group item's description that will appear on sales
    * forms that include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -330,6 +332,8 @@ export namespace SalesTaxGroupItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -364,6 +368,8 @@ export interface SalesTaxGroupItemUpdateParams {
   /**
    * Body param: The sales-tax group item's description that will appear on sales
    * forms that include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -411,6 +417,8 @@ export namespace SalesTaxGroupItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -453,8 +461,17 @@ export interface SalesTaxGroupItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for sales-tax group items whose `name` is alphabetically
-   * greater than or equal to this value.
+   * Query param: Filter for sales-tax group items whose `name` 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 sales-tax group items
+   * sorted by `name` in that order; without either, the order is not guaranteed. To
+   * page through sales-tax group items 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;
 
@@ -481,8 +498,16 @@ export interface SalesTaxGroupItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for sales-tax group items whose `name` is alphabetically
-   * less than or equal to this value.
+   * Query param: Filter for sales-tax group items 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.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax group items
+   * sorted by `name` 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;
 

package/src/resources/qbd/sales-tax-items.ts

@@ -351,6 +351,8 @@ export interface SalesTaxItemCreateParams {
   /**
    * Body param: The sales-tax item's description that will appear on sales forms
    * that include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -411,6 +413,8 @@ export namespace SalesTaxItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -452,6 +456,8 @@ export interface SalesTaxItemUpdateParams {
   /**
    * Body param: The sales-tax item's description that will appear on sales forms
    * that include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -514,6 +520,8 @@ export namespace SalesTaxItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -562,8 +570,17 @@ export interface SalesTaxItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for sales-tax items whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for sales-tax items whose `name` 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 sales-tax items sorted
+   * by `name` in that order; without either, the order is not guaranteed. To page
+   * through sales-tax items 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;
 
@@ -589,8 +606,16 @@ export interface SalesTaxItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for sales-tax items whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for sales-tax items 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.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax items sorted
+   * by `name` 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;
 

package/src/resources/qbd/sales-tax-payment-checks.ts

@@ -592,6 +592,8 @@ export interface SalesTaxPaymentCheckCreateParams {
 
   /**
    * Body param: A memo or note for this sales-tax payment check.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -640,6 +642,8 @@ export namespace SalesTaxPaymentCheckCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -682,6 +686,8 @@ export namespace SalesTaxPaymentCheckCreateParams {
     /**
      * 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;
 
@@ -742,6 +748,8 @@ export interface SalesTaxPaymentCheckUpdateParams {
 
   /**
    * Body param: A memo or note for this sales-tax payment check.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -778,6 +786,8 @@ export namespace SalesTaxPaymentCheckUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -820,6 +830,8 @@ export namespace SalesTaxPaymentCheckUpdateParams {
     /**
      * 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;
 
@@ -895,6 +907,9 @@ export interface SalesTaxPaymentCheckListParams extends CursorPageParams {
    * than or equal 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;
 
@@ -925,6 +940,9 @@ export interface SalesTaxPaymentCheckListParams extends CursorPageParams {
    * or equal to 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/service-items.ts

@@ -700,6 +700,8 @@ export namespace ServiceItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -731,12 +733,17 @@ export namespace ServiceItemCreateParams {
     /**
      * The cost at which this item is purchased from vendors, represented as a decimal
      * string.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     purchaseCost?: string;
 
     /**
      * The description of this item that appears on purchase forms (e.g., checks,
      * bills, item receipts) when it is ordered or bought from vendors.
+     *
+     * Maximum length: 4095 characters.
      */
     purchaseDescription?: string;
 
@@ -749,12 +756,17 @@ export namespace ServiceItemCreateParams {
     /**
      * The description of this item that appears on sales forms (e.g., invoices, sales
      * receipts) when sold to customers.
+     *
+     * Maximum length: 4095 characters.
      */
     salesDescription?: string;
 
     /**
      * The price at which this item is sold to customers, represented as a decimal
      * string.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     salesPrice?: string;
   }
@@ -778,12 +790,17 @@ export namespace ServiceItemCreateParams {
 
     /**
      * A description of this item.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
     /**
      * The price at which this item is purchased or sold, represented as a decimal
      * string.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     price?: string;
 
@@ -933,6 +950,8 @@ export namespace ServiceItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -964,12 +983,17 @@ export namespace ServiceItemUpdateParams {
     /**
      * The cost at which this item is purchased from vendors, represented as a decimal
      * string.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     purchaseCost?: string;
 
     /**
      * The description of this item that appears on purchase forms (e.g., checks,
      * bills, item receipts) when it is ordered or bought from vendors.
+     *
+     * Maximum length: 4095 characters.
      */
     purchaseDescription?: string;
 
@@ -982,12 +1006,17 @@ export namespace ServiceItemUpdateParams {
     /**
      * The description of this item that appears on sales forms (e.g., invoices, sales
      * receipts) when sold to customers.
+     *
+     * Maximum length: 4095 characters.
      */
     salesDescription?: string;
 
     /**
      * The price at which this item is sold to customers, represented as a decimal
      * string.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     salesPrice?: string;
 
@@ -1024,6 +1053,8 @@ export namespace ServiceItemUpdateParams {
   export interface SalesOrPurchaseDetails {
     /**
      * A description of this item.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -1036,6 +1067,9 @@ export namespace ServiceItemUpdateParams {
     /**
      * The price at which this item is purchased or sold, represented as a decimal
      * string.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     price?: string;
 
@@ -1116,8 +1150,17 @@ export interface ServiceItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for service items whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for service items 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 service items sorted by
+   * `fullName` in that order; without either, the order is not guaranteed. To page
+   * through service items 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;
 
@@ -1131,8 +1174,16 @@ export interface ServiceItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for service items whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for service items 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 service items 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;
 

package/src/resources/qbd/shipping-methods.ts

@@ -205,13 +205,12 @@ export interface ShippingMethodListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * shipping methods. 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`).
+   * shipping methods, so this parameter only limits the response size. To page
+   * through shipping methods 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 shipping methods
-   * without limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because shipping methods typically have low record counts.
+   * without limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -234,8 +233,17 @@ export interface ShippingMethodListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for shipping methods whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for shipping methods whose `name` 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 shipping methods sorted
+   * by `name` in that order; without either, the order is not guaranteed. To page
+   * through shipping methods 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;
 
@@ -262,8 +270,16 @@ export interface ShippingMethodListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for shipping methods whose `name` is alphabetically less
-   * than or equal to this value.
+   * Query param: Filter for shipping methods 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.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns shipping methods sorted
+   * by `name` 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;
 

package/src/resources/qbd/standard-terms.ts

@@ -237,13 +237,12 @@ export interface StandardTermListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * standard terms. 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`).
+   * standard terms, so this parameter only limits the response size. To page through
+   * standard terms 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 standard terms without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because standard terms typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -266,8 +265,17 @@ export interface StandardTermListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for standard terms whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for standard terms whose `name` 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 standard terms sorted by
+   * `name` in that order; without either, the order is not guaranteed. To page
+   * through standard terms 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;
 
@@ -293,8 +301,16 @@ export interface StandardTermListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for standard terms whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for standard terms 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.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns standard terms sorted by
+   * `name` 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;
 

package/src/resources/qbd/subtotal-items.ts

@@ -257,6 +257,8 @@ export interface SubtotalItemCreateParams {
   /**
    * Body param: The subtotal item's description that will appear on sales forms that
    * include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -294,6 +296,8 @@ export namespace SubtotalItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -328,6 +332,8 @@ export interface SubtotalItemUpdateParams {
   /**
    * Body param: The subtotal item's description that will appear on sales forms that
    * include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -367,6 +373,8 @@ export namespace SubtotalItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -409,8 +417,17 @@ export interface SubtotalItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for subtotal items whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for subtotal items whose `name` 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 subtotal items sorted by
+   * `name` in that order; without either, the order is not guaranteed. To page
+   * through subtotal items 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;
 
@@ -436,8 +453,16 @@ export interface SubtotalItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for subtotal items whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for subtotal items 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.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns subtotal items sorted by
+   * `name` 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;
 

package/src/resources/qbd/time-tracking-activities.ts

@@ -473,6 +473,8 @@ export interface TimeTrackingActivityCreateParams {
 
   /**
    * Body param: A note or comment about this time tracking activity.
+   *
+   * Maximum length: 4095 characters.
    */
   note?: string;
 
@@ -571,6 +573,8 @@ export interface TimeTrackingActivityUpdateParams {
 
   /**
    * Body param: A note or comment about this time tracking activity.
+   *
+   * Maximum length: 4095 characters.
    */
   note?: string;
 

package/src/resources/qbd/transactions.ts

@@ -356,6 +356,9 @@ export interface TransactionListParams 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;
 
@@ -386,6 +389,9 @@ export interface TransactionListParams 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/transfers.ts

@@ -280,6 +280,8 @@ export interface TransferCreateParams {
 
   /**
    * Body param: A memo or note for this transfer.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 }
@@ -323,6 +325,8 @@ export interface TransferUpdateParams {
 
   /**
    * Body param: A memo or note for this transfer.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;