conductor-node 14.24.2 → 14.24.4

package/src/resources/qbd/sales-receipts.ts

@@ -2289,6 +2289,8 @@ export interface SalesReceiptCreateParams {
 
   /**
    * Body param: The check number of a check received for this sales receipt.
+   *
+   * Maximum length: 25 characters.
    */
   checkNumber?: string;
 
@@ -2397,6 +2399,8 @@ export interface SalesReceiptCreateParams {
   /**
    * Body param: A memo or note for this sales receipt that appears in reports, but
    * not on the sales receipt.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -2408,6 +2412,8 @@ export interface SalesReceiptCreateParams {
    * doesn't fit into 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;
 
@@ -2510,6 +2516,8 @@ export namespace SalesReceiptCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2552,6 +2560,8 @@ export namespace SalesReceiptCreateParams {
     /**
      * 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;
 
@@ -2607,16 +2617,22 @@ export namespace SalesReceiptCreateParams {
 
       /**
        * The cardholder's name on the card.
+       *
+       * Maximum length: 41 characters.
        */
       name: string;
 
       /**
        * The credit card number. Must be masked with lower case "x" and no dashes.
+       *
+       * Maximum length: 25 characters.
        */
       number: string;
 
       /**
        * The card's billing address.
+       *
+       * Maximum length: 41 characters.
        */
       address?: string;
 
@@ -2625,11 +2641,15 @@ export namespace SalesReceiptCreateParams {
        * (purchase, corporate, or business) for Visa and Mastercard transactions only.
        * When provided, this code may qualify the transaction for lower processing fees
        * compared to the standard rates that apply when no code is specified.
+       *
+       * Maximum length: 24 characters.
        */
       commercialCardCode?: string;
 
       /**
        * The card's billing address ZIP or postal code.
+       *
+       * Maximum length: 18 characters.
        */
       postalCode?: string;
 
@@ -2652,12 +2672,16 @@ export namespace SalesReceiptCreateParams {
     export interface Response {
       /**
        * The ID returned from the credit card processor for this credit card transaction.
+       *
+       * Maximum length: 24 characters.
        */
       creditCardTransactionId: string;
 
       /**
        * The QBMS account number of the merchant who is running this transaction using
        * the customer's credit card.
+       *
+       * Maximum length: 32 characters.
        */
       merchantAccountNumber: string;
 
@@ -2676,6 +2700,8 @@ export namespace SalesReceiptCreateParams {
       /**
        * The status message returned in the original QBMS transaction response for this
        * credit card transaction.
+       *
+       * Maximum length: 60 characters.
        */
       statusMessage: string;
 
@@ -2688,6 +2714,8 @@ export namespace SalesReceiptCreateParams {
       /**
        * The authorization code returned from the credit card processor to indicate that
        * this charge will be paid by the card issuer.
+       *
+       * Maximum length: 12 characters.
        */
       authorizationCode?: string;
 
@@ -2713,6 +2741,8 @@ export namespace SalesReceiptCreateParams {
       /**
        * A value returned from QBMS transactions for future use by the QuickBooks
        * Reconciliation feature.
+       *
+       * Maximum length: 16 characters.
        */
       clientTransactionId?: string;
 
@@ -2725,6 +2755,8 @@ export namespace SalesReceiptCreateParams {
       /**
        * An internal ID returned by QuickBooks Merchant Services (QBMS) from the
        * transaction request, needed for the QuickBooks reconciliation feature.
+       *
+       * Maximum length: 84 characters.
        */
       reconBatchId?: string;
 
@@ -2781,6 +2813,8 @@ export namespace SalesReceiptCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this sales receipt line group.
      * Must be a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2790,6 +2824,8 @@ export namespace SalesReceiptCreateParams {
       /**
        * 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;
 
@@ -2849,6 +2885,8 @@ export namespace SalesReceiptCreateParams {
 
     /**
      * A description of this sales receipt line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2875,6 +2913,8 @@ export namespace SalesReceiptCreateParams {
     /**
      * The lot number of the item associated with this sales receipt line. Used for
      * tracking groups of inventory items that are purchased or manufactured together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -2885,6 +2925,8 @@ export namespace SalesReceiptCreateParams {
      * 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;
 
@@ -2895,6 +2937,8 @@ export namespace SalesReceiptCreateParams {
      * 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;
 
@@ -2958,6 +3002,8 @@ export namespace SalesReceiptCreateParams {
     /**
      * The serial number of the item associated with this sales receipt line. This is
      * used for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -2971,6 +3017,8 @@ export namespace SalesReceiptCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this sales receipt line. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -3013,16 +3061,22 @@ export namespace SalesReceiptCreateParams {
 
         /**
          * The cardholder's name on the card.
+         *
+         * Maximum length: 41 characters.
          */
         name: string;
 
         /**
          * The credit card number. Must be masked with lower case "x" and no dashes.
+         *
+         * Maximum length: 25 characters.
          */
         number: string;
 
         /**
          * The card's billing address.
+         *
+         * Maximum length: 41 characters.
          */
         address?: string;
 
@@ -3031,11 +3085,15 @@ export namespace SalesReceiptCreateParams {
          * (purchase, corporate, or business) for Visa and Mastercard transactions only.
          * When provided, this code may qualify the transaction for lower processing fees
          * compared to the standard rates that apply when no code is specified.
+         *
+         * Maximum length: 24 characters.
          */
         commercialCardCode?: string;
 
         /**
          * The card's billing address ZIP or postal code.
+         *
+         * Maximum length: 18 characters.
          */
         postalCode?: string;
 
@@ -3058,12 +3116,16 @@ export namespace SalesReceiptCreateParams {
       export interface Response {
         /**
          * The ID returned from the credit card processor for this credit card transaction.
+         *
+         * Maximum length: 24 characters.
          */
         creditCardTransactionId: string;
 
         /**
          * The QBMS account number of the merchant who is running this transaction using
          * the customer's credit card.
+         *
+         * Maximum length: 32 characters.
          */
         merchantAccountNumber: string;
 
@@ -3082,6 +3144,8 @@ export namespace SalesReceiptCreateParams {
         /**
          * The status message returned in the original QBMS transaction response for this
          * credit card transaction.
+         *
+         * Maximum length: 60 characters.
          */
         statusMessage: string;
 
@@ -3094,6 +3158,8 @@ export namespace SalesReceiptCreateParams {
         /**
          * The authorization code returned from the credit card processor to indicate that
          * this charge will be paid by the card issuer.
+         *
+         * Maximum length: 12 characters.
          */
         authorizationCode?: string;
 
@@ -3119,6 +3185,8 @@ export namespace SalesReceiptCreateParams {
         /**
          * A value returned from QBMS transactions for future use by the QuickBooks
          * Reconciliation feature.
+         *
+         * Maximum length: 16 characters.
          */
         clientTransactionId?: string;
 
@@ -3131,6 +3199,8 @@ export namespace SalesReceiptCreateParams {
         /**
          * An internal ID returned by QuickBooks Merchant Services (QBMS) from the
          * transaction request, needed for the QuickBooks reconciliation feature.
+         *
+         * Maximum length: 84 characters.
          */
         reconBatchId?: string;
 
@@ -3146,6 +3216,8 @@ export namespace SalesReceiptCreateParams {
       /**
        * 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;
 
@@ -3181,6 +3253,8 @@ export namespace SalesReceiptCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -3223,6 +3297,8 @@ export namespace SalesReceiptCreateParams {
     /**
      * 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 +3346,8 @@ export interface SalesReceiptUpdateParams {
 
   /**
    * Body param: The check number of a check received for this sales receipt.
+   *
+   * Maximum length: 25 characters.
    */
   checkNumber?: string;
 
@@ -3380,6 +3458,8 @@ export interface SalesReceiptUpdateParams {
   /**
    * Body param: A memo or note for this sales receipt that appears in reports, but
    * not on the sales receipt.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -3391,6 +3471,8 @@ export interface SalesReceiptUpdateParams {
    * doesn't fit into 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;
 
@@ -3493,6 +3575,8 @@ export namespace SalesReceiptUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -3535,6 +3619,8 @@ export namespace SalesReceiptUpdateParams {
     /**
      * 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;
 
@@ -3615,6 +3701,8 @@ export namespace SalesReceiptUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this sales receipt line group.
      * Must be a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -3653,6 +3741,8 @@ export namespace SalesReceiptUpdateParams {
 
       /**
        * A description of this sales receipt line.
+       *
+       * Maximum length: 4095 characters.
        */
       description?: string;
 
@@ -3679,6 +3769,8 @@ export namespace SalesReceiptUpdateParams {
       /**
        * The lot number of the item associated with this sales receipt line. Used for
        * tracking groups of inventory items that are purchased or manufactured together.
+       *
+       * Maximum length: 40 characters.
        */
       lotNumber?: string;
 
@@ -3689,6 +3781,8 @@ export namespace SalesReceiptUpdateParams {
        * 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;
 
@@ -3699,6 +3793,8 @@ export namespace SalesReceiptUpdateParams {
        * 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;
 
@@ -3777,6 +3873,8 @@ export namespace SalesReceiptUpdateParams {
       /**
        * The serial number of the item associated with this sales receipt line. This is
        * used for tracking individual units of serialized inventory items.
+       *
+       * Maximum length: 4095 characters.
        */
       serialNumber?: string;
 
@@ -3790,6 +3888,8 @@ export namespace SalesReceiptUpdateParams {
       /**
        * The unit-of-measure used for the `quantity` in this sales receipt line. Must be
        * a valid unit within the item's available units of measure.
+       *
+       * Maximum length: 31 characters.
        */
       unitOfMeasure?: string;
     }
@@ -3828,6 +3928,8 @@ export namespace SalesReceiptUpdateParams {
 
     /**
      * A description of this sales receipt line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -3854,6 +3956,8 @@ export namespace SalesReceiptUpdateParams {
     /**
      * The lot number of the item associated with this sales receipt line. Used for
      * tracking groups of inventory items that are purchased or manufactured together.
+     *
+     * Maximum length: 40 characters.
      */
     lotNumber?: string;
 
@@ -3864,6 +3968,8 @@ export namespace SalesReceiptUpdateParams {
      * 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;
 
@@ -3874,6 +3980,8 @@ export namespace SalesReceiptUpdateParams {
      * 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;
 
@@ -3952,6 +4060,8 @@ export namespace SalesReceiptUpdateParams {
     /**
      * The serial number of the item associated with this sales receipt line. This is
      * used for tracking individual units of serialized inventory items.
+     *
+     * Maximum length: 4095 characters.
      */
     serialNumber?: string;
 
@@ -3965,6 +4075,8 @@ export namespace SalesReceiptUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this sales receipt line. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -3982,6 +4094,8 @@ export namespace SalesReceiptUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -4024,6 +4138,8 @@ export namespace SalesReceiptUpdateParams {
     /**
      * 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;
 
@@ -4104,6 +4220,9 @@ export interface SalesReceiptListParams extends CursorPageParams {
    * 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;
 
@@ -4134,6 +4253,9 @@ export interface SalesReceiptListParams extends CursorPageParams {
    * 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/sales-representatives.ts

@@ -298,13 +298,10 @@ export interface SalesRepresentativeListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * sales representatives. 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`).
+   * sales representatives, so this parameter only limits the response size.
    *
    * When this parameter is omitted, the endpoint returns all sales representatives
-   * without limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because sales representatives typically have low record counts.
+   * without limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -327,8 +324,12 @@ export interface SalesRepresentativeListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for sales representatives whose `name` is alphabetically
-   * greater than or equal to this value.
+   * Query param: Filter for sales representatives whose `initial` 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;
 
@@ -355,8 +356,13 @@ export interface SalesRepresentativeListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for sales representatives whose `name` is alphabetically
-   * less than or equal to this value.
+   * Query param: Filter for sales representatives whose `initial` 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/sales-tax-codes.ts

@@ -249,6 +249,8 @@ export interface SalesTaxCodeCreateParams {
 
   /**
    * Body param: A description of this sales-tax code.
+   *
+   * Maximum length: 31 characters.
    */
   description?: string;
 
@@ -290,6 +292,8 @@ export interface SalesTaxCodeUpdateParams {
 
   /**
    * Body param: A description of this sales-tax code.
+   *
+   * Maximum length: 31 characters.
    */
   description?: string;
 
@@ -350,13 +354,12 @@ export interface SalesTaxCodeListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * sales-tax codes. 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`).
+   * sales-tax codes, so this parameter only limits the response size. To page
+   * through sales-tax codes 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 sales-tax codes without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because sales-tax codes typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -379,8 +382,17 @@ export interface SalesTaxCodeListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for sales-tax codes whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for sales-tax codes 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 codes sorted
+   * by `name` in that order; without either, the order is not guaranteed. To page
+   * through sales-tax codes 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;
 
@@ -406,8 +418,16 @@ export interface SalesTaxCodeListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for sales-tax codes whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for sales-tax codes 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 codes 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;