conductor-node 14.11.0 → 14.13.0

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

@@ -391,6 +391,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The other-name's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -422,6 +424,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The other-name's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -459,6 +463,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The other-name's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 
@@ -587,6 +593,8 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The other-name's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -608,6 +616,8 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The other-name's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -657,6 +667,8 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The other-name's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 

package/src/resources/qbd/payroll-wage-items.ts

@@ -258,6 +258,9 @@ export interface PayrollWageItemCreateParams {
   /**
    * Body param: The default rate for this payroll wage item, represented as a
    * decimal string. Only one of `rate` and `ratePercent` can be set.
+   *
+   * 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/price-levels.ts

@@ -317,13 +317,21 @@ export interface PriceLevelCreateParams {
 
 export namespace PriceLevelCreateParams {
   export interface PerItemPriceLevel {
+    /**
+     * The item associated with this per-item price level. This can refer to any good
+     * or service that the business buys or sells, including item types such as a
+     * service item, inventory item, or special calculation item like a discount item
+     * or sales-tax item.
+     */
+    itemId: string;
+
     /**
      * The percentage adjustment for this per-item price level when using relative
      * pricing. Specifies a percentage to modify pricing, using positive values (e.g.,
      * "20") to increase prices by that percentage, or negative values (e.g., "-10") to
      * apply a discount.
      */
-    adjustPercentage: string;
+    adjustPercentage?: string;
 
     /**
      * The base value reference for this per-item price level's percentage adjustment.
@@ -335,15 +343,7 @@ export namespace PriceLevelCreateParams {
      * (`adjustPercentage` with `adjustRelativeTo`) when configuring per-item price
      * levels.
      */
-    adjustRelativeTo: 'cost' | 'current_custom_price' | 'standard_price';
-
-    /**
-     * The item associated with this per-item price level. This can refer to any good
-     * or service that the business buys or sells, including item types such as a
-     * service item, inventory item, or special calculation item like a discount item
-     * or sales-tax item.
-     */
-    itemId: string;
+    adjustRelativeTo?: 'cost' | 'current_custom_price' | 'standard_price';
 
     /**
      * The fixed amount custom price for this per-item price level that overrides the
@@ -428,13 +428,21 @@ export interface PriceLevelUpdateParams {
 
 export namespace PriceLevelUpdateParams {
   export interface PerItemPriceLevel {
+    /**
+     * The item associated with this per-item price level. This can refer to any good
+     * or service that the business buys or sells, including item types such as a
+     * service item, inventory item, or special calculation item like a discount item
+     * or sales-tax item.
+     */
+    itemId: string;
+
     /**
      * The percentage adjustment for this per-item price level when using relative
      * pricing. Specifies a percentage to modify pricing, using positive values (e.g.,
      * "20") to increase prices by that percentage, or negative values (e.g., "-10") to
      * apply a discount.
      */
-    adjustPercentage: string;
+    adjustPercentage?: string;
 
     /**
      * The base value reference for this per-item price level's percentage adjustment.
@@ -446,15 +454,7 @@ export namespace PriceLevelUpdateParams {
      * (`adjustPercentage` with `adjustRelativeTo`) when configuring per-item price
      * levels.
      */
-    adjustRelativeTo: 'cost' | 'current_custom_price' | 'standard_price';
-
-    /**
-     * The item associated with this per-item price level. This can refer to any good
-     * or service that the business buys or sells, including item types such as a
-     * service item, inventory item, or special calculation item like a discount item
-     * or sales-tax item.
-     */
-    itemId: string;
+    adjustRelativeTo?: 'cost' | 'current_custom_price' | 'standard_price';
 
     /**
      * The fixed amount custom price for this per-item price level that overrides the

package/src/resources/qbd/purchase-orders.ts

@@ -1805,6 +1805,8 @@ export interface PurchaseOrderCreateParams {
    * 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;
 
@@ -1826,6 +1828,8 @@ export interface PurchaseOrderCreateParams {
    * for 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;
 
@@ -1948,6 +1952,9 @@ export namespace PurchaseOrderCreateParams {
      * will 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;
 
@@ -2031,6 +2038,9 @@ export namespace PurchaseOrderCreateParams {
      * 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;
 
@@ -2391,6 +2401,8 @@ export interface PurchaseOrderUpdateParams {
    * order, 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;
 
@@ -2412,6 +2424,8 @@ export interface PurchaseOrderUpdateParams {
    * for 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;
 
@@ -2541,6 +2555,9 @@ export namespace PurchaseOrderUpdateParams {
        * will 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;
 
@@ -2638,6 +2655,9 @@ export namespace PurchaseOrderUpdateParams {
        * 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;
 
@@ -2690,6 +2710,9 @@ export namespace PurchaseOrderUpdateParams {
      * will 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;
 
@@ -2787,6 +2810,9 @@ export namespace PurchaseOrderUpdateParams {
      * 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/qbd.ts

@@ -445,6 +445,21 @@ import {
   ReceivePayments,
   ReceivePaymentsCursorPage,
 } from './receive-payments';
+import * as ReportsAPI from './reports';
+import {
+  Report,
+  ReportAgingParams,
+  ReportBudgetSummaryParams,
+  ReportCustomDetailParams,
+  ReportCustomSummaryParams,
+  ReportGeneralDetailParams,
+  ReportGeneralSummaryParams,
+  ReportJobParams,
+  ReportPayrollDetailParams,
+  ReportPayrollSummaryParams,
+  ReportTimeParams,
+  Reports,
+} from './reports';
 import * as SalesOrdersAPI from './sales-orders';
 import {
   SalesOrder,
@@ -673,6 +688,7 @@ export class Qbd extends APIResource {
   priceLevels: PriceLevelsAPI.PriceLevels = new PriceLevelsAPI.PriceLevels(this._client);
   purchaseOrders: PurchaseOrdersAPI.PurchaseOrders = new PurchaseOrdersAPI.PurchaseOrders(this._client);
   receivePayments: ReceivePaymentsAPI.ReceivePayments = new ReceivePaymentsAPI.ReceivePayments(this._client);
+  reports: ReportsAPI.Reports = new ReportsAPI.Reports(this._client);
   salesOrders: SalesOrdersAPI.SalesOrders = new SalesOrdersAPI.SalesOrders(this._client);
   salesReceipts: SalesReceiptsAPI.SalesReceipts = new SalesReceiptsAPI.SalesReceipts(this._client);
   salesRepresentatives: SalesRepresentativesAPI.SalesRepresentatives =
@@ -778,6 +794,7 @@ Qbd.PayrollWageItems = PayrollWageItems;
 Qbd.PriceLevels = PriceLevels;
 Qbd.PurchaseOrders = PurchaseOrders;
 Qbd.ReceivePayments = ReceivePayments;
+Qbd.Reports = Reports;
 Qbd.SalesOrders = SalesOrders;
 Qbd.SalesReceipts = SalesReceipts;
 Qbd.SalesRepresentatives = SalesRepresentatives;
@@ -1249,6 +1266,21 @@ export declare namespace Qbd {
     type ReceivePaymentDeleteParams as ReceivePaymentDeleteParams,
   };
 
+  export {
+    Reports as Reports,
+    type Report as Report,
+    type ReportAgingParams as ReportAgingParams,
+    type ReportBudgetSummaryParams as ReportBudgetSummaryParams,
+    type ReportCustomDetailParams as ReportCustomDetailParams,
+    type ReportCustomSummaryParams as ReportCustomSummaryParams,
+    type ReportGeneralDetailParams as ReportGeneralDetailParams,
+    type ReportGeneralSummaryParams as ReportGeneralSummaryParams,
+    type ReportJobParams as ReportJobParams,
+    type ReportPayrollDetailParams as ReportPayrollDetailParams,
+    type ReportPayrollSummaryParams as ReportPayrollSummaryParams,
+    type ReportTimeParams as ReportTimeParams,
+  };
+
   export {
     SalesOrders as SalesOrders,
     type SalesOrder as SalesOrder,

package/src/resources/qbd/receive-payments.ts

@@ -9,10 +9,10 @@ import { path } from '../../internal/utils/path';
 
 export class ReceivePayments extends APIResource {
   /**
-   * Records a customer payment and optionally applies it to specific invoices or
-   * credits. All allocations must target the same accounts receivable account as
-   * those invoices, and each one has to include a payment amount, discount, or
-   * credit so QuickBooks can close out the balance.
+   * Records a customer payment and optionally applies it to specific invoices,
+   * discounts, or credits. All allocations must target the same accounts receivable
+   * account as those invoices, and each one has to include a payment amount,
+   * discount, or credit so QuickBooks can close out the balance.
    *
    * @example
    * ```ts
@@ -841,6 +841,9 @@ export interface ReceivePaymentCreateParams {
    *
    * **NOTE**: The sum of the `paymentAmount` amounts in the `applyToTransactions`
    * array cannot exceed the `totalAmount`, or you will receive an error.
+   *
+   * Decimal string format: exactly 2 decimal places when cents are included and up
+   * to 13 digits before the decimal point (for example, "123.45").
    */
   totalAmount: string;
 
@@ -948,6 +951,8 @@ export interface ReceivePaymentCreateParams {
    * This 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: 20 characters.
    */
   refNumber?: string;
 }
@@ -960,9 +965,9 @@ export namespace ReceivePaymentCreateParams {
     transactionId: string;
 
     /**
-     * Credit memos to apply to this receivable transaction, reducing its balance. This
+     * Credits to apply to this receivable transaction, reducing its balance. This
      * creates a link between this receivable transaction and the specified credit
-     * memos.
+     * transactions.
      *
      * **IMPORTANT**: By default, QuickBooks will not return any information about the
      * linked transactions in this endpoint's response even when this request is
@@ -981,6 +986,9 @@ export namespace ReceivePaymentCreateParams {
     /**
      * The monetary amount by which to reduce the receivable transaction's receivable
      * amount, 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").
      */
     discountAmount?: string;
 
@@ -992,6 +1000,9 @@ export namespace ReceivePaymentCreateParams {
     /**
      * The monetary amount to apply to the receivable transaction, 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").
      */
     paymentAmount?: string;
   }
@@ -1001,12 +1012,15 @@ export namespace ReceivePaymentCreateParams {
       /**
        * 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;
 
       /**
-       * The unique identifier of the credit transaction (credit memo or vendor credit)
-       * to apply to this transaction.
+       * The unique identifier of the credit transaction to apply to this transaction,
+       * such as a credit memo, vendor credit, or journal-entry credit.
        */
       creditTransactionId: string;
 
@@ -1273,6 +1287,8 @@ export interface ReceivePaymentUpdateParams {
    * receive-payment, 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: 20 characters.
    */
   refNumber?: string;
 
@@ -1282,6 +1298,9 @@ export interface ReceivePaymentUpdateParams {
    *
    * **NOTE**: The sum of the `paymentAmount` amounts in the `applyToTransactions`
    * array cannot exceed the `totalAmount`, or you will receive an error.
+   *
+   * Decimal string format: exactly 2 decimal places when cents are included and up
+   * to 13 digits before the decimal point (for example, "123.45").
    */
   totalAmount?: string;
 
@@ -1299,9 +1318,9 @@ export namespace ReceivePaymentUpdateParams {
     transactionId: string;
 
     /**
-     * Credit memos to apply to this receivable transaction, reducing its balance. This
+     * Credits to apply to this receivable transaction, reducing its balance. This
      * creates a link between this receivable transaction and the specified credit
-     * memos.
+     * transactions.
      *
      * **IMPORTANT**: By default, QuickBooks will not return any information about the
      * linked transactions in this endpoint's response even when this request is
@@ -1320,6 +1339,9 @@ export namespace ReceivePaymentUpdateParams {
     /**
      * The monetary amount by which to reduce the receivable transaction's receivable
      * amount, 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").
      */
     discountAmount?: string;
 
@@ -1331,6 +1353,9 @@ export namespace ReceivePaymentUpdateParams {
     /**
      * The monetary amount to apply to the receivable transaction, 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").
      */
     paymentAmount?: string;
   }
@@ -1340,12 +1365,15 @@ export namespace ReceivePaymentUpdateParams {
       /**
        * 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;
 
       /**
-       * The unique identifier of the credit transaction (credit memo or vendor credit)
-       * to apply to this transaction.
+       * The unique identifier of the credit transaction to apply to this transaction,
+       * such as a credit memo, vendor credit, or journal-entry credit.
        */
       creditTransactionId: string;