conductor-node 14.11.0 → 14.12.0

package/src/resources/qbd/credit-memos.ts

@@ -1930,6 +1930,8 @@ export interface CreditMemoCreateParams {
    * not required to be unique and can be arbitrarily changed by the QuickBooks user.
    * When left blank in this create request, this field will be left blank in
    * QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -1964,6 +1966,8 @@ export interface CreditMemoCreateParams {
    * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
    * for this field, which stands for "freight on board". This field is informational
    * and has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2148,6 +2152,9 @@ export namespace CreditMemoCreateParams {
      * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
      * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
      * `1` and the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2242,6 +2249,9 @@ export namespace CreditMemoCreateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 
@@ -2542,6 +2552,8 @@ export interface CreditMemoUpdateParams {
    * Body param: The case-sensitive user-defined reference number for this credit
    * memo, which can be used to identify the transaction in QuickBooks. This value is
    * not required to be unique and can be arbitrarily changed by the QuickBooks user.
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -2576,6 +2588,8 @@ export interface CreditMemoUpdateParams {
    * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
    * for this field, which stands for "freight on board". This field is informational
    * and has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2760,6 +2774,9 @@ export namespace CreditMemoUpdateParams {
        * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
        * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
        * `1` and the suggested `rate`. This field cannot be cleared.
+       *
+       * Decimal string format: exactly 2 decimal places when cents are included and up
+       * to 13 digits before the decimal point (for example, "123.45").
        */
       amount?: string;
 
@@ -2859,6 +2876,9 @@ export namespace CreditMemoUpdateParams {
        * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
        * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
        * decimal string. This field cannot be cleared.
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       rate?: string;
 
@@ -2916,6 +2936,9 @@ export namespace CreditMemoUpdateParams {
      * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
      * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
      * `1` and the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -3015,6 +3038,9 @@ export namespace CreditMemoUpdateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 

package/src/resources/qbd/customers.ts

@@ -1124,6 +1124,8 @@ export interface CustomerCreateParams {
 
   /**
    * Body param: The customer's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -1211,6 +1213,8 @@ export interface CustomerCreateParams {
 
   /**
    * Body param: The customer's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -1310,6 +1314,8 @@ export interface CustomerCreateParams {
 
   /**
    * Body param: The customer's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 
@@ -1788,6 +1794,8 @@ export interface CustomerUpdateParams {
 
   /**
    * Body param: The customer's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -1865,6 +1873,8 @@ export interface CustomerUpdateParams {
 
   /**
    * Body param: The customer's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -1964,6 +1974,8 @@ export interface CustomerUpdateParams {
 
   /**
    * Body param: The customer's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 

package/src/resources/qbd/deposits.ts

@@ -698,6 +698,9 @@ export namespace DepositCreateParams {
     /**
      * The cash-back amount taken out of the deposit and recorded to this deposit
      * cash-back line's account, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -718,6 +721,9 @@ export namespace DepositCreateParams {
     /**
      * For a manual deposit line, the amount transferred from the line's account into
      * the deposit's destination account, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -882,6 +888,9 @@ export namespace DepositUpdateParams {
     /**
      * The cash-back amount taken out of the deposit and recorded to this deposit
      * cash-back line's account, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -910,6 +919,9 @@ export namespace DepositUpdateParams {
     /**
      * For a manual deposit line, the amount transferred from the line's account into
      * the deposit's destination account, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 

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

@@ -163,7 +163,7 @@ export interface DiscountItem {
 
   /**
    * The monetary amount to subtract from the total or subtotal when applying this
-   * discount item to a transaction.
+   * discount item to a transaction, represented as a decimal string.
    *
    * **NOTE**: A flat rate discount applies to ALL lines recorded above it and
    * distributes the discount amount equally across those lines, which affects tax
@@ -436,13 +436,16 @@ export interface DiscountItemCreateParams {
 
   /**
    * Body param: The monetary amount to subtract from the total or subtotal when
-   * applying this discount item to a transaction.
+   * applying this discount item to a transaction, represented as a decimal string.
    *
    * **NOTE**: A flat rate discount applies to ALL lines recorded above it and
    * distributes the discount amount equally across those lines, which affects tax
    * calculations. For example, a $10 discount applied to a $100 taxable item and
    * $100 non-taxable item would result in a $5 taxable discount and $5 non-taxable
    * discount.
+   *
+   * Decimal string format: up to 5 decimal places and up to 10 digits before the
+   * decimal point (for example, "123.45").
    */
   discountRate?: string;
 
@@ -561,13 +564,16 @@ export interface DiscountItemUpdateParams {
 
   /**
    * Body param: The monetary amount to subtract from the total or subtotal when
-   * applying this discount item to a transaction.
+   * applying this discount item to a transaction, represented as a decimal string.
    *
    * **NOTE**: A flat rate discount applies to ALL lines recorded above it and
    * distributes the discount amount equally across those lines, which affects tax
    * calculations. For example, a $10 discount applied to a $100 taxable item and
    * $100 non-taxable item would result in a $5 taxable discount and $5 non-taxable
    * discount.
+   *
+   * Decimal string format: up to 5 decimal places and up to 10 digits before the
+   * decimal point (for example, "123.45").
    */
   discountRate?: string;
 

package/src/resources/qbd/employees.ts

@@ -926,6 +926,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -1014,6 +1016,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -1076,6 +1080,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's mobile phone number.
+   *
+   * Maximum length: 21 characters.
    */
   mobile?: string;
 
@@ -1098,6 +1104,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's pager number.
+   *
+   * Maximum length: 21 characters.
    */
   pager?: string;
 
@@ -1108,6 +1116,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 
@@ -1436,6 +1446,9 @@ export namespace EmployeeCreateParams {
 
       /**
        * The hourly rate for this employee, 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").
        */
       rate?: string;
 
@@ -1603,6 +1616,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -1681,6 +1696,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -1738,6 +1755,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's mobile phone number.
+   *
+   * Maximum length: 21 characters.
    */
   mobile?: string;
 
@@ -1760,6 +1779,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's pager number.
+   *
+   * Maximum length: 21 characters.
    */
   pager?: string;
 
@@ -1770,6 +1791,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 
@@ -2107,6 +2130,9 @@ export namespace EmployeeUpdateParams {
 
       /**
        * The hourly rate for this employee, 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").
        */
       rate?: string;
 

package/src/resources/qbd/estimates.ts

@@ -1741,6 +1741,8 @@ export interface EstimateCreateParams {
    * required to be unique and can be arbitrarily changed by the QuickBooks user.
    * When left blank in this create request, this field will be left blank in
    * QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -1775,6 +1777,8 @@ export interface EstimateCreateParams {
    * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
    * for this field, which stands for "freight on board". This field is informational
    * and has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -1943,6 +1947,9 @@ export namespace EstimateCreateParams {
      * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
      * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
      * the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2050,6 +2057,9 @@ export namespace EstimateCreateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 
@@ -2330,6 +2340,8 @@ export interface EstimateUpdateParams {
    * Body param: The case-sensitive user-defined reference number for this estimate,
    * which can be used to identify the transaction in QuickBooks. This value is not
    * required to be unique and can be arbitrarily changed by the QuickBooks user.
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -2364,6 +2376,8 @@ export interface EstimateUpdateParams {
    * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
    * for this field, which stands for "freight on board". This field is informational
    * and has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2539,6 +2553,9 @@ export namespace EstimateUpdateParams {
        * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
        * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
        * the suggested `rate`. This field cannot be cleared.
+       *
+       * Decimal string format: exactly 2 decimal places when cents are included and up
+       * to 13 digits before the decimal point (for example, "123.45").
        */
       amount?: string;
 
@@ -2645,6 +2662,9 @@ export namespace EstimateUpdateParams {
        * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
        * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
        * decimal string. This field cannot be cleared.
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       rate?: string;
 
@@ -2692,6 +2712,9 @@ export namespace EstimateUpdateParams {
      * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
      * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
      * the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2798,6 +2821,9 @@ export namespace EstimateUpdateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 

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

@@ -641,6 +641,8 @@ export interface InventoryAdjustmentCreateParams {
    * value is not required to be unique and can be arbitrarily changed by the
    * QuickBooks user. When left blank in this create request, this field will be left
    * blank in QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 }
@@ -901,6 +903,8 @@ export interface InventoryAdjustmentUpdateParams {
    * adjustment, which can be used to identify the transaction in QuickBooks. This
    * value is not required to be unique and can be arbitrarily changed by the
    * QuickBooks user.
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 

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

@@ -780,11 +780,14 @@ export interface InventoryAssemblyItemCreateParams {
   salesTaxCodeId?: string;
 
   /**
-   * Body param: The total value of this inventory assembly item. If `totalValue` is
-   * provided, `quantityOnHand` must also be provided and must be greater than zero.
-   * If both `quantityOnHand` and `purchaseCost` are provided, then `totalValue` will
-   * be set to `quantityOnHand` times `purchaseCost`, regardless of what `totalValue`
-   * is explicitly set to.
+   * Body param: The total value of this inventory assembly item, represented as a
+   * decimal string. If `totalValue` is provided, `quantityOnHand` must also be
+   * provided and must be greater than zero. If both `quantityOnHand` and
+   * `purchaseCost` are provided, then `totalValue` will be set to `quantityOnHand`
+   * times `purchaseCost`, regardless of what `totalValue` is explicitly set to.
+   *
+   * Decimal string format: exactly 2 decimal places when cents are included and up
+   * to 13 digits before the decimal point (for example, "123.45").
    */
   totalValue?: string;
 

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

@@ -709,11 +709,14 @@ export interface InventoryItemCreateParams {
   sku?: string;
 
   /**
-   * Body param: The total value of this inventory item. If `totalValue` is provided,
-   * `quantityOnHand` must also be provided and must be greater than zero. If both
-   * `quantityOnHand` and `purchaseCost` are provided, then `totalValue` will be set
-   * to `quantityOnHand` times `purchaseCost`, regardless of what `totalValue` is
-   * explicitly set to.
+   * Body param: The total value of this inventory item, represented as a decimal
+   * string. If `totalValue` is provided, `quantityOnHand` must also be provided and
+   * must be greater than zero. If both `quantityOnHand` and `purchaseCost` are
+   * provided, then `totalValue` will be set to `quantityOnHand` times
+   * `purchaseCost`, regardless of what `totalValue` is explicitly set to.
+   *
+   * Decimal string format: exactly 2 decimal places when cents are included and up
+   * to 13 digits before the decimal point (for example, "123.45").
    */
   totalValue?: string;
 

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

@@ -444,6 +444,8 @@ export interface InventorySiteUpdateParams {
 
   /**
    * Body param: The inventory site's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -472,6 +474,8 @@ export interface InventorySiteUpdateParams {
 
   /**
    * Body param: The inventory site's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 }

package/src/resources/qbd/invoices.ts

@@ -2004,6 +2004,8 @@ export interface InvoiceCreateParams {
    * required to be unique and can be arbitrarily changed by the QuickBooks user.
    * When left blank in this create request, this field will be left blank in
    * QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -2048,6 +2050,8 @@ export interface InvoiceCreateParams {
    * transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for
    * this field, which stands for "freight on board". This field is informational and
    * has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2080,6 +2084,9 @@ export namespace InvoiceCreateParams {
     /**
      * The amount of credit applied to this transaction. This could include customer
      * deposits, payments, or credits. Represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     appliedAmount: string;
 
@@ -2251,6 +2258,9 @@ export namespace InvoiceCreateParams {
      * them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
      * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
      * `1` and the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2384,6 +2394,9 @@ export namespace InvoiceCreateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 
@@ -2740,6 +2753,8 @@ export interface InvoiceUpdateParams {
    * Body param: The case-sensitive user-defined reference number for this invoice,
    * which can be used to identify the transaction in QuickBooks. This value is not
    * required to be unique and can be arbitrarily changed by the QuickBooks user.
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -2784,6 +2799,8 @@ export interface InvoiceUpdateParams {
    * transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for
    * this field, which stands for "freight on board". This field is informational and
    * has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2821,6 +2838,9 @@ export namespace InvoiceUpdateParams {
     /**
      * The amount of credit applied to this transaction. This could include customer
      * deposits, payments, or credits. Represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     appliedAmount: string;
 
@@ -2987,6 +3007,9 @@ export namespace InvoiceUpdateParams {
        * them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
        * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
        * `1` and the suggested `rate`. This field cannot be cleared.
+       *
+       * Decimal string format: exactly 2 decimal places when cents are included and up
+       * to 13 digits before the decimal point (for example, "123.45").
        */
       amount?: string;
 
@@ -3092,6 +3115,9 @@ export namespace InvoiceUpdateParams {
        * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
        * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
        * decimal string. This field cannot be cleared.
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       rate?: string;
 
@@ -3148,6 +3174,9 @@ export namespace InvoiceUpdateParams {
      * them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
      * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
      * `1` and the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -3253,6 +3282,9 @@ export namespace InvoiceUpdateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;