conductor-node 14.24.2 → 14.24.4

package/src/resources/qbd/other-names.ts

@@ -360,7 +360,7 @@ export interface OtherNameCreateParams {
    * hierarchical objects, which is why `name` is unique for them but not for objects
    * that have parents.
    *
-   * Maximum length: 31 characters.
+   * Maximum length: 41 characters.
    */
   name: string;
 
@@ -376,6 +376,8 @@ export interface OtherNameCreateParams {
    * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
    * the account number may not be visible in the user interface, but it can still be
    * set and retrieved through the API.
+   *
+   * Maximum length: 99 characters.
    */
   accountNumber?: string;
 
@@ -386,6 +388,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The name of a alternate contact person for this other-name.
+   *
+   * Maximum length: 41 characters.
    */
   alternateContact?: string;
 
@@ -406,11 +410,15 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The name of the primary contact person for this other-name.
+   *
+   * Maximum length: 41 characters.
    */
   contact?: string;
 
   /**
    * Body param: The other-name's email address.
+   *
+   * Maximum length: 1023 characters.
    */
   email?: string;
 
@@ -460,6 +468,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: A note or comment about this other-name.
+   *
+   * Maximum length: 4095 characters.
    */
   note?: string;
 
@@ -473,6 +483,8 @@ export interface OtherNameCreateParams {
   /**
    * Body param: The formal salutation title that precedes the name of the contact
    * person for this other-name, such as "Mr.", "Ms.", or "Dr.".
+   *
+   * Maximum length: 15 characters.
    */
   salutation?: string;
 }
@@ -491,6 +503,8 @@ export namespace OtherNameCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -533,6 +547,8 @@ export namespace OtherNameCreateParams {
     /**
      * 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;
 
@@ -580,6 +596,8 @@ export interface OtherNameUpdateParams {
    * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
    * the account number may not be visible in the user interface, but it can still be
    * set and retrieved through the API.
+   *
+   * Maximum length: 99 characters.
    */
   accountNumber?: string;
 
@@ -590,6 +608,8 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The name of a alternate contact person for this other-name.
+   *
+   * Maximum length: 41 characters.
    */
   alternateContact?: string;
 
@@ -610,11 +630,15 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The name of the primary contact person for this other-name.
+   *
+   * Maximum length: 41 characters.
    */
   contact?: string;
 
   /**
    * Body param: The other-name's email address.
+   *
+   * Maximum length: 1023 characters.
    */
   email?: string;
 
@@ -660,12 +684,14 @@ export interface OtherNameUpdateParams {
    * hierarchical objects, which is why `name` is unique for them but not for objects
    * that have parents.
    *
-   * Maximum length: 31 characters.
+   * Maximum length: 41 characters.
    */
   name?: string;
 
   /**
    * Body param: A note or comment about this other-name.
+   *
+   * Maximum length: 4095 characters.
    */
   note?: string;
 
@@ -679,6 +705,8 @@ export interface OtherNameUpdateParams {
   /**
    * Body param: The formal salutation title that precedes the name of the contact
    * person for this other-name, such as "Mr.", "Ms.", or "Dr.".
+   *
+   * Maximum length: 15 characters.
    */
   salutation?: string;
 }
@@ -697,6 +725,8 @@ export namespace OtherNameUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -739,6 +769,8 @@ export namespace OtherNameUpdateParams {
     /**
      * 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;
 
@@ -780,13 +812,12 @@ export interface OtherNameListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * other-names. 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`).
+   * other-names, so this parameter only limits the response size. To page through
+   * other-names 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 other-names without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because other-names typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -809,8 +840,17 @@ export interface OtherNameListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for other-names whose `name` is alphabetically greater than
-   * or equal to this value.
+   * Query param: Filter for other-names 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 other-names sorted by
+   * `name` in that order; without either, the order is not guaranteed. To page
+   * through other-names 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;
 
@@ -836,8 +876,16 @@ export interface OtherNameListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for other-names whose `name` is alphabetically less than or
-   * equal to this value.
+   * Query param: Filter for other-names 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 other-names 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/payment-methods.ts

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

@@ -252,6 +252,9 @@ export interface PayrollWageItemCreateParams {
   /**
    * Body param: The overtime pay multiplier for this payroll wage item, represented
    * as a decimal string. For example, `"1.5"` represents time-and-a-half pay.
+   *
+   * Decimal string format: up to 5 decimal places and up to 10 digits before the
+   * decimal point (for example, "123.45").
    */
   overtimeMultiplier?: string;
 
@@ -315,8 +318,17 @@ export interface PayrollWageItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for payroll wage items whose `name` is alphabetically
-   * greater than or equal to this value.
+   * Query param: Filter for payroll wage 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 payroll wage items
+   * sorted by `name` in that order; without either, the order is not guaranteed. To
+   * page through payroll wage 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;
 
@@ -343,8 +355,16 @@ export interface PayrollWageItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for payroll wage items whose `name` is alphabetically less
-   * than or equal to this value.
+   * Query param: Filter for payroll wage 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 payroll wage 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/price-levels.ts

@@ -202,8 +202,8 @@ export namespace PriceLevel {
   export interface PerItemPriceLevel {
     /**
      * The fixed amount custom price for this per-item price level that overrides the
-     * standard price for the specified item. Used when setting an absolute price value
-     * for the item in this price level.
+     * standard price for the specified item, represented as a decimal string. Used
+     * when setting an absolute price value for the item in this price level.
      */
     customPrice: string | null;
 
@@ -347,8 +347,11 @@ export namespace PriceLevelCreateParams {
 
     /**
      * The fixed amount custom price for this per-item price level that overrides the
-     * standard price for the specified item. Used when setting an absolute price value
-     * for the item in this price level.
+     * standard price for the specified item, represented as a decimal string. Used
+     * when setting an absolute price value for the item in this price level.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     customPrice?: string;
 
@@ -458,8 +461,11 @@ export namespace PriceLevelUpdateParams {
 
     /**
      * The fixed amount custom price for this per-item price level that overrides the
-     * standard price for the specified item. Used when setting an absolute price value
-     * for the item in this price level.
+     * standard price for the specified item, represented as a decimal string. Used
+     * when setting an absolute price value for the item in this price level.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     customPrice?: string;
 
@@ -504,13 +510,10 @@ export interface PriceLevelListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * price levels. 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`).
+   * price levels, so this parameter only limits the response size.
    *
    * When this parameter is omitted, the endpoint returns all price levels without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because price levels typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -533,8 +536,17 @@ export interface PriceLevelListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for price levels whose `name` is alphabetically greater than
-   * or equal to this value.
+   * Query param: Filter for price levels whose `name` sorts at or after this value
+   * (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
+   * first, then digits, then letters.
+   *
+   * **IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks does not
+   * return price levels sorted by name: it returns fixed-percentage price levels
+   * first, then per-item price levels, each group sorted by name. Do not use these
+   * parameters to page through price levels.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameFrom?: string;
 
@@ -560,8 +572,18 @@ export interface PriceLevelListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for price levels whose `name` is alphabetically less than or
-   * equal to this value.
+   * Query param: Filter for price levels 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.
+   *
+   * **IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks does not
+   * return price levels sorted by name: it returns fixed-percentage price levels
+   * first, then per-item price levels, each group sorted by name. Do not use these
+   * parameters to page through price levels.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameTo?: string;