conductor-node 14.24.2 → 14.24.4

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

@@ -658,6 +658,9 @@ export interface InventoryItemCreateParams {
   /**
    * Body param: The cost at which this inventory 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;
 
@@ -665,6 +668,8 @@ export interface InventoryItemCreateParams {
    * Body param: The description of this inventory 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;
 
@@ -691,12 +696,17 @@ export interface InventoryItemCreateParams {
   /**
    * Body param: The description of this inventory 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 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;
 
@@ -716,6 +726,8 @@ export interface InventoryItemCreateParams {
   /**
    * Body param: The inventory item's stock keeping unit (SKU), which is sometimes
    * the manufacturer's part number.
+   *
+   * Maximum length: 31 characters.
    */
   sku?: string;
 
@@ -759,6 +771,8 @@ export namespace InventoryItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -869,6 +883,9 @@ export interface InventoryItemUpdateParams {
   /**
    * Body param: The cost at which this inventory 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;
 
@@ -876,6 +893,8 @@ export interface InventoryItemUpdateParams {
    * Body param: The description of this inventory 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;
 
@@ -894,12 +913,17 @@ export interface InventoryItemUpdateParams {
   /**
    * Body param: The description of this inventory 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 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;
 
@@ -919,6 +943,8 @@ export interface InventoryItemUpdateParams {
   /**
    * Body param: The inventory item's stock keeping unit (SKU), which is sometimes
    * the manufacturer's part number.
+   *
+   * Maximum length: 31 characters.
    */
   sku?: string;
 
@@ -970,6 +996,8 @@ export namespace InventoryItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -1034,8 +1062,17 @@ export interface InventoryItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for inventory items whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for inventory 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 items sorted
+   * by `fullName` in that order; without either, the order is not guaranteed. To
+   * page through inventory 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;
 
@@ -1049,8 +1086,16 @@ export interface InventoryItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for inventory items whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for inventory 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 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/inventory-sites.ts

@@ -312,11 +312,15 @@ export interface InventorySiteCreateParams {
 
   /**
    * Body param: A description of this inventory site.
+   *
+   * Maximum length: 100 characters.
    */
   description?: string;
 
   /**
    * Body param: The inventory site's email address.
+   *
+   * Maximum length: 1023 characters.
    */
   email?: string;
 
@@ -346,6 +350,8 @@ export namespace InventorySiteCreateParams {
 
     /**
      * The country name of the site address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -429,16 +435,22 @@ export interface InventorySiteUpdateParams {
 
   /**
    * Body param: The name of the primary contact person for this inventory site.
+   *
+   * Maximum length: 41 characters.
    */
   contact?: string;
 
   /**
    * Body param: A description of this inventory site.
+   *
+   * Maximum length: 100 characters.
    */
   description?: string;
 
   /**
    * Body param: The inventory site's email address.
+   *
+   * Maximum length: 1023 characters.
    */
   email?: string;
 
@@ -494,6 +506,8 @@ export namespace InventorySiteUpdateParams {
 
     /**
      * The country name of the site address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -586,8 +600,12 @@ export interface InventorySiteListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for inventory sites whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for inventory sites 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;
 
@@ -614,8 +632,13 @@ export interface InventorySiteListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for inventory sites whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for inventory sites 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/invoices.ts

@@ -1995,6 +1995,8 @@ export interface InvoiceCreateParams {
   /**
    * Body param: A memo or note for this invoice that appears in reports, but not on
    * the invoice. Use `customerMessage` to add a note to this invoice.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -2006,6 +2008,8 @@ export interface InvoiceCreateParams {
    * 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;
 
@@ -2146,6 +2150,8 @@ export namespace InvoiceCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2188,6 +2194,8 @@ export namespace InvoiceCreateParams {
     /**
      * 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;
 
@@ -2251,6 +2259,8 @@ export namespace InvoiceCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this invoice line group. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2260,6 +2270,8 @@ export namespace InvoiceCreateParams {
       /**
        * 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;
 
@@ -2312,6 +2324,8 @@ export namespace InvoiceCreateParams {
 
     /**
      * A description of this invoice line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2372,6 +2386,8 @@ export namespace InvoiceCreateParams {
     /**
      * The lot number of the item associated with this invoice line. Used for tracking
      * groups of inventory items that are purchased or manufactured together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -2381,6 +2397,8 @@ export namespace InvoiceCreateParams {
      * standard QuickBooks field that exists for all invoice 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;
 
@@ -2391,6 +2409,8 @@ export namespace InvoiceCreateParams {
      * 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;
 
@@ -2454,6 +2474,8 @@ export namespace InvoiceCreateParams {
     /**
      * The serial number of the item associated with this invoice line. This is used
      * for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -2466,6 +2488,8 @@ export namespace InvoiceCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this invoice line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2475,6 +2499,8 @@ export namespace InvoiceCreateParams {
       /**
        * 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;
 
@@ -2554,6 +2580,8 @@ export namespace InvoiceCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2596,6 +2624,8 @@ export namespace InvoiceCreateParams {
     /**
      * 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;
 
@@ -2752,6 +2782,8 @@ export interface InvoiceUpdateParams {
   /**
    * Body param: A memo or note for this invoice that appears in reports, but not on
    * the invoice. Use `customerMessage` to add a note to this invoice.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -2763,6 +2795,8 @@ export interface InvoiceUpdateParams {
    * 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;
 
@@ -2906,6 +2940,8 @@ export namespace InvoiceUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2948,6 +2984,8 @@ export namespace InvoiceUpdateParams {
     /**
      * 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;
 
@@ -3028,6 +3066,8 @@ export namespace InvoiceUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this invoice line group. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -3065,6 +3105,8 @@ export namespace InvoiceUpdateParams {
 
       /**
        * A description of this invoice line.
+       *
+       * Maximum length: 4095 characters.
        */
       description?: string;
 
@@ -3091,6 +3133,8 @@ export namespace InvoiceUpdateParams {
       /**
        * The lot number of the item associated with this invoice line. Used for tracking
        * groups of inventory items that are purchased or manufactured together.
+       *
+       * Maximum length: 40 characters.
        */
       lotNumber?: string;
 
@@ -3100,6 +3144,8 @@ export namespace InvoiceUpdateParams {
        * standard QuickBooks field that exists for all invoice 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;
 
@@ -3110,6 +3156,8 @@ export namespace InvoiceUpdateParams {
        * 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;
 
@@ -3188,6 +3236,8 @@ export namespace InvoiceUpdateParams {
       /**
        * The serial number of the item associated with this invoice line. This is used
        * for tracking individual units of serialized inventory items.
+       *
+       * Maximum length: 4095 characters.
        */
       serialNumber?: string;
 
@@ -3200,6 +3250,8 @@ export namespace InvoiceUpdateParams {
       /**
        * The unit-of-measure used for the `quantity` in this invoice line. Must be a
        * valid unit within the item's available units of measure.
+       *
+       * Maximum length: 31 characters.
        */
       unitOfMeasure?: string;
     }
@@ -3237,6 +3289,8 @@ export namespace InvoiceUpdateParams {
 
     /**
      * A description of this invoice line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -3263,6 +3317,8 @@ export namespace InvoiceUpdateParams {
     /**
      * The lot number of the item associated with this invoice line. Used for tracking
      * groups of inventory items that are purchased or manufactured together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -3272,6 +3328,8 @@ export namespace InvoiceUpdateParams {
      * standard QuickBooks field that exists for all invoice 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;
 
@@ -3282,6 +3340,8 @@ export namespace InvoiceUpdateParams {
      * 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;
 
@@ -3360,6 +3420,8 @@ export namespace InvoiceUpdateParams {
     /**
      * The serial number of the item associated with this invoice line. This is used
      * for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -3372,6 +3434,8 @@ export namespace InvoiceUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this invoice line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -3389,6 +3453,8 @@ export namespace InvoiceUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -3431,6 +3497,8 @@ export namespace InvoiceUpdateParams {
     /**
      * 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;
 
@@ -3520,6 +3588,9 @@ export interface InvoiceListParams 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;
 
@@ -3549,6 +3620,9 @@ export interface InvoiceListParams extends CursorPageParams {
    * 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/item-groups.ts

@@ -347,6 +347,8 @@ export interface ItemGroupCreateParams {
   /**
    * Body param: The item group's description that will appear on sales forms that
    * include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -399,6 +401,8 @@ export namespace ItemGroupCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -424,6 +428,8 @@ export namespace ItemGroupCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this item group line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -465,6 +471,8 @@ export interface ItemGroupUpdateParams {
   /**
    * Body param: The item group's description that will appear on sales forms that
    * include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -540,6 +548,8 @@ export namespace ItemGroupUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -565,6 +575,8 @@ export namespace ItemGroupUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this item group line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -607,8 +619,17 @@ export interface ItemGroupListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for item groups whose `name` is alphabetically greater than
-   * or equal to this value.
+   * Query param: Filter for item groups 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 item groups sorted by
+   * `name` in that order; without either, the order is not guaranteed. To page
+   * through item groups 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;
 
@@ -634,8 +655,16 @@ export interface ItemGroupListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for item groups whose `name` is alphabetically less than or
-   * equal to this value.
+   * Query param: Filter for item groups 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 item groups 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;