conductor-node 14.24.2 → 14.24.4

package/src/resources/qbd/estimates.ts

@@ -769,7 +769,8 @@ export namespace Estimate {
 
       /**
        * The markup that will be passed on to the customer for this item on this estimate
-       * line. `amount = (quantity * rate) * (1 + markupRate)`
+       * line, represented as a decimal string.
+       * `amount = (quantity * rate) * (1 + markupRate)`
        */
       markupRate: string | null;
 
@@ -1133,7 +1134,8 @@ export namespace Estimate {
 
     /**
      * The markup that will be passed on to the customer for this item on this estimate
-     * line. `amount = (quantity * rate) * (1 + markupRate)`
+     * line, represented as a decimal string.
+     * `amount = (quantity * rate) * (1 + markupRate)`
      */
     markupRate: string | null;
 
@@ -1743,6 +1745,8 @@ export interface EstimateCreateParams {
   /**
    * Body param: A memo or note for this estimate that appears in reports, but not on
    * the estimate. Use `customerMessage` to add a note to this estimate.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -1754,6 +1758,8 @@ export interface EstimateCreateParams {
    * 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;
 
@@ -1840,6 +1846,8 @@ export namespace EstimateCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -1882,6 +1890,8 @@ export namespace EstimateCreateParams {
     /**
      * 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;
 
@@ -1938,6 +1948,8 @@ export namespace EstimateCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line group. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -1947,6 +1959,8 @@ export namespace EstimateCreateParams {
       /**
        * 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;
 
@@ -2002,6 +2016,8 @@ export namespace EstimateCreateParams {
 
     /**
      * A description of this estimate line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2027,7 +2043,11 @@ export namespace EstimateCreateParams {
 
     /**
      * The markup that will be passed on to the customer for this item on this estimate
-     * line. `amount = (quantity * rate) * (1 + markupRate)`
+     * line, represented as a decimal string.
+     * `amount = (quantity * rate) * (1 + markupRate)`
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     markupRate?: string;
 
@@ -2044,6 +2064,8 @@ export namespace EstimateCreateParams {
      * standard QuickBooks field that exists for all estimate 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;
 
@@ -2054,6 +2076,8 @@ export namespace EstimateCreateParams {
      * 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;
 
@@ -2117,6 +2141,8 @@ export namespace EstimateCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2126,6 +2152,8 @@ export namespace EstimateCreateParams {
       /**
        * 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;
 
@@ -2161,6 +2189,8 @@ export namespace EstimateCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2203,6 +2233,8 @@ export namespace EstimateCreateParams {
     /**
      * 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;
 
@@ -2346,6 +2378,8 @@ export interface EstimateUpdateParams {
   /**
    * Body param: A memo or note for this estimate that appears in reports, but not on
    * the estimate. Use `customerMessage` to add a note to this estimate.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -2357,6 +2391,8 @@ export interface EstimateUpdateParams {
    * 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;
 
@@ -2446,6 +2482,8 @@ export namespace EstimateUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2488,6 +2526,8 @@ export namespace EstimateUpdateParams {
     /**
      * 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;
 
@@ -2568,6 +2608,8 @@ export namespace EstimateUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line group. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2608,6 +2650,8 @@ export namespace EstimateUpdateParams {
 
       /**
        * A description of this estimate line.
+       *
+       * Maximum length: 4095 characters.
        */
       description?: string;
 
@@ -2633,7 +2677,11 @@ export namespace EstimateUpdateParams {
 
       /**
        * The markup that will be passed on to the customer for this item on this estimate
-       * line. `amount = (quantity * rate) * (1 + markupRate)`
+       * line, represented as a decimal string.
+       * `amount = (quantity * rate) * (1 + markupRate)`
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       markupRate?: string;
 
@@ -2650,6 +2698,8 @@ export namespace EstimateUpdateParams {
        * standard QuickBooks field that exists for all estimate 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;
 
@@ -2660,6 +2710,8 @@ export namespace EstimateUpdateParams {
        * 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;
 
@@ -2732,6 +2784,8 @@ export namespace EstimateUpdateParams {
       /**
        * The unit-of-measure used for the `quantity` in this estimate line. Must be a
        * valid unit within the item's available units of measure.
+       *
+       * Maximum length: 31 characters.
        */
       unitOfMeasure?: string;
     }
@@ -2772,6 +2826,8 @@ export namespace EstimateUpdateParams {
 
     /**
      * A description of this estimate line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2797,7 +2853,11 @@ export namespace EstimateUpdateParams {
 
     /**
      * The markup that will be passed on to the customer for this item on this estimate
-     * line. `amount = (quantity * rate) * (1 + markupRate)`
+     * line, represented as a decimal string.
+     * `amount = (quantity * rate) * (1 + markupRate)`
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     markupRate?: string;
 
@@ -2814,6 +2874,8 @@ export namespace EstimateUpdateParams {
      * standard QuickBooks field that exists for all estimate 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;
 
@@ -2824,6 +2886,8 @@ export namespace EstimateUpdateParams {
      * 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;
 
@@ -2896,6 +2960,8 @@ export namespace EstimateUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2913,6 +2979,8 @@ export namespace EstimateUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2955,6 +3023,8 @@ export namespace EstimateUpdateParams {
     /**
      * 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;
 
@@ -3039,6 +3109,9 @@ export interface EstimateListParams extends CursorPageParams {
    * 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;
 
@@ -3068,6 +3141,9 @@ export interface EstimateListParams 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/inventory-adjustments.ts

@@ -632,6 +632,8 @@ export interface InventoryAdjustmentCreateParams {
 
   /**
    * Body param: A memo or note for this inventory adjustment.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -707,6 +709,8 @@ export namespace InventoryAdjustmentCreateParams {
        * The lot number of the item associated with this inventory adjustment line. Used
        * for tracking groups of inventory items that are purchased or manufactured
        * together.
+       *
+       * Maximum length: 40 characters.
        */
       lotNumber?: string;
     }
@@ -734,6 +738,8 @@ export namespace InventoryAdjustmentCreateParams {
        * The lot number of the item associated with this inventory adjustment line. Used
        * for tracking groups of inventory items that are purchased or manufactured
        * together.
+       *
+       * Maximum length: 40 characters.
        */
       lotNumber?: string;
 
@@ -753,6 +759,8 @@ export namespace InventoryAdjustmentCreateParams {
       /**
        * The serial number of the item associated with this inventory adjustment line.
        * This is used for tracking individual units of serialized inventory items.
+       *
+       * Maximum length: 4095 characters.
        */
       serialNumber?: string;
     }
@@ -765,6 +773,8 @@ export namespace InventoryAdjustmentCreateParams {
       /**
        * The serial number, which represents a unique unit of the inventory item
        * associated with this inventory adjustment line, to add to inventory.
+       *
+       * Maximum length: 4095 characters.
        */
       addSerialNumber?: string;
 
@@ -785,6 +795,8 @@ export namespace InventoryAdjustmentCreateParams {
       /**
        * The serial number, which represents a unique unit of the inventory item
        * associated with this inventory adjustment line, to remove from inventory.
+       *
+       * Maximum length: 4095 characters.
        */
       removeSerialNumber?: string;
     }
@@ -802,10 +814,13 @@ export namespace InventoryAdjustmentCreateParams {
 
       /**
        * The new total value of the entire stock of the inventory item associated with
-       * this inventory adjustment line.
+       * this inventory adjustment line, represented as a decimal string.
        *
        * **NOTE**: The new value does _not_ have to equal `quantityOnHand` times
        * `purchaseCost`.
+       *
+       * Decimal string format: exactly 2 decimal places when cents are included and up
+       * to 13 digits before the decimal point (for example, "123.45").
        */
       newValue?: string;
 
@@ -821,6 +836,9 @@ export namespace InventoryAdjustmentCreateParams {
        * the entire stock of the inventory item associated with this inventory adjustment
        * line. A positive number increases the value, while a negative number decreases
        * it.
+       *
+       * Must have at most 2 decimal places and at most 13 digits before the decimal
+       * point.
        */
       valueDifference?: number;
     }
@@ -895,6 +913,8 @@ export interface InventoryAdjustmentUpdateParams {
 
   /**
    * Body param: A memo or note for this inventory adjustment.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -955,6 +975,8 @@ export namespace InventoryAdjustmentUpdateParams {
      * The lot number of the item associated with this inventory adjustment line. Used
      * for tracking groups of inventory items that are purchased or manufactured
      * together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -968,6 +990,8 @@ export namespace InventoryAdjustmentUpdateParams {
     /**
      * The serial number of the item associated with this inventory adjustment line.
      * This is used for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -976,6 +1000,9 @@ export namespace InventoryAdjustmentUpdateParams {
      * the entire stock of the inventory item associated with this inventory adjustment
      * line. A positive number increases the value, while a negative number decreases
      * it.
+     *
+     * Must have at most 2 decimal places and at most 13 digits before the decimal
+     * point.
      */
     valueDifference?: number;
   }
@@ -1023,13 +1050,10 @@ export interface InventoryAdjustmentListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * inventory adjustments. 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`).
+   * inventory adjustments, so this parameter only limits the response size.
    *
    * When this parameter is omitted, the endpoint returns all inventory adjustments
-   * without limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because inventory adjustments typically have low record counts.
+   * without limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -1056,6 +1080,9 @@ export interface InventoryAdjustmentListParams {
    * 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;
 
@@ -1086,6 +1113,9 @@ export interface InventoryAdjustmentListParams {
    * 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/inventory-assembly-items.ts

@@ -740,6 +740,9 @@ export interface InventoryAssemblyItemCreateParams {
   /**
    * Body param: The cost at which this inventory assembly 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;
 
@@ -747,6 +750,8 @@ export interface InventoryAssemblyItemCreateParams {
    * Body param: The description of this inventory assembly 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;
 
@@ -768,12 +773,17 @@ export interface InventoryAssemblyItemCreateParams {
   /**
    * Body param: The description of this inventory assembly item that appears on
    * sales forms (e.g., invoices, sales receipts) when sold to customers.
+   *
+   * Maximum length: 4095 characters.
    */
   salesDescription?: string;
 
   /**
    * Body param: The price at which this inventory assembly 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;
 
@@ -830,6 +840,8 @@ export namespace InventoryAssemblyItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -980,6 +992,9 @@ export interface InventoryAssemblyItemUpdateParams {
   /**
    * Body param: The cost at which this inventory assembly 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;
 
@@ -987,6 +1002,8 @@ export interface InventoryAssemblyItemUpdateParams {
    * Body param: The description of this inventory assembly 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;
 
@@ -999,12 +1016,17 @@ export interface InventoryAssemblyItemUpdateParams {
   /**
    * Body param: The description of this inventory assembly item that appears on
    * sales forms (e.g., invoices, sales receipts) when sold to customers.
+   *
+   * Maximum length: 4095 characters.
    */
   salesDescription?: string;
 
   /**
    * Body param: The price at which this inventory assembly 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 +1046,8 @@ export interface InventoryAssemblyItemUpdateParams {
   /**
    * Body param: The inventory assembly item's stock keeping unit (SKU), which is
    * sometimes the manufacturer's part number.
+   *
+   * Maximum length: 31 characters.
    */
   sku?: string;
 
@@ -1065,6 +1089,8 @@ export namespace InventoryAssemblyItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -1144,8 +1170,17 @@ export interface InventoryAssemblyItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for inventory assembly items whose `name` is alphabetically
-   * greater than or equal to this value.
+   * Query param: Filter for inventory assembly 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 inventory assembly items
+   * sorted by `fullName` in that order; without either, the order is not guaranteed.
+   * To page through inventory assembly 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;
 
@@ -1159,8 +1194,16 @@ export interface InventoryAssemblyItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for inventory assembly items whose `name` is alphabetically
-   * less than or equal to this value.
+   * Query param: Filter for inventory assembly 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 inventory assembly 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;