conductor-node 14.10.0 → 14.12.0

package/src/resources/qbd/journal-entries.ts

@@ -65,6 +65,10 @@ export class JournalEntries extends APIResource {
    * include the related customer or vendor on any A/R or A/P line you submit in the
    * update body.
    *
+   * **NOTE:** If you include `lines`, QuickBooks Desktop replaces that line list
+   * with the array you send, so include unchanged lines you want to keep and use
+   * `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const journalEntry =
@@ -774,6 +778,8 @@ export interface JournalEntryCreateParams {
    * 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;
 }
@@ -789,6 +795,9 @@ export namespace JournalEntryCreateParams {
     /**
      * The monetary amount of this journal credit line, 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;
 
@@ -841,6 +850,9 @@ export namespace JournalEntryCreateParams {
 
     /**
      * The monetary amount of this journal debit line, 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;
 
@@ -951,6 +963,8 @@ export interface JournalEntryUpdateParams {
    * entry, 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;
 
@@ -977,6 +991,9 @@ export namespace JournalEntryUpdateParams {
 
     /**
      * The monetary amount of this journal line, 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/other-names.ts

@@ -74,9 +74,10 @@ export class OtherNames extends APIResource {
   }
 
   /**
-   * Returns a list of other-names. NOTE: QuickBooks Desktop does not support
-   * pagination for other-names; hence, there is no `cursor` parameter. Users
-   * typically have few other-names.
+   * Returns a list of other-names.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for other-names; hence,
+   * there is no `cursor` parameter. Users typically have few other-names.
    *
    * @example
    * ```ts
@@ -390,6 +391,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The other-name's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -421,6 +424,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The other-name's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -458,6 +463,8 @@ export interface OtherNameCreateParams {
 
   /**
    * Body param: The other-name's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 
@@ -586,6 +593,8 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The other-name's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -607,6 +616,8 @@ export interface OtherNameUpdateParams {
 
   /**
    * Body param: The other-name's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -656,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/payment-methods.ts

@@ -58,9 +58,10 @@ export class PaymentMethods extends APIResource {
   }
 
   /**
-   * Returns a list of payment methods. NOTE: QuickBooks Desktop does not support
-   * pagination for payment methods; hence, there is no `cursor` parameter. Users
-   * typically have few payment methods.
+   * Returns a list of payment methods.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for payment methods;
+   * hence, there is no `cursor` parameter. Users typically have few payment methods.
    *
    * @example
    * ```ts

package/src/resources/qbd/payments-to-deposit.ts

@@ -0,0 +1,201 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+
+export class PaymentsToDeposit extends APIResource {
+  /**
+   * Lists received customer payments that are currently available to include in a
+   * QuickBooks Desktop deposit. Use each result's `paymentTransactionId` and, when
+   * present, `paymentTransactionLineId` as the corresponding fields on a deposit
+   * line.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for payments to
+   * deposit; hence, there is no `cursor` parameter. Users typically have few
+   * payments to deposit.
+   *
+   * @example
+   * ```ts
+   * const paymentsToDeposits =
+   *   await conductor.qbd.paymentsToDeposit.list({
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
+   */
+  list(
+    params: PaymentsToDepositListParams,
+    options?: RequestOptions,
+  ): APIPromise<PaymentsToDepositListResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.get('/quickbooks-desktop/payments-to-deposit', {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
+}
+
+export interface PaymentToDeposit {
+  /**
+   * The monetary amount of this received payment that is currently available to
+   * deposit, represented as a decimal string.
+   */
+  amount: string;
+
+  /**
+   * The monetary amount of this payment to deposit converted to the home currency of
+   * the QuickBooks company file. Represented as a decimal string.
+   */
+  amountInHomeCurrency: string | null;
+
+  /**
+   * The payment to deposit's currency. For built-in currencies, the name and code
+   * are standard ISO 4217 international values. For user-defined currencies, all
+   * values are editable.
+   */
+  currency: PaymentToDeposit.Currency | null;
+
+  /**
+   * The customer or customer-job associated with this payment to deposit.
+   */
+  customer: PaymentToDeposit.Customer | null;
+
+  /**
+   * The market exchange rate between this payment to deposit's currency and the home
+   * currency in QuickBooks at the time of this transaction. Represented as a decimal
+   * value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
+   */
+  exchangeRate: number | null;
+
+  /**
+   * The ID of the received payment that is available to deposit. Pass this value as
+   * `paymentTransactionId` when creating a deposit line.
+   */
+  paymentTransactionId: string;
+
+  /**
+   * The ID of the specific received-payment line that is available to deposit. If
+   * this value is not `null`, pass it as `paymentTransactionLineId` with
+   * `paymentTransactionId` when creating a deposit line.
+   */
+  paymentTransactionLineId: string | null;
+
+  /**
+   * The case-sensitive user-defined reference number for this payment to deposit,
+   * 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.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date of this payment to deposit, in ISO 8601 format (YYYY-MM-DD).
+   */
+  transactionDate: string;
+
+  /**
+   * The type of transaction for this payment to deposit.
+   */
+  transactionType:
+    | 'ar_refund_credit_card'
+    | 'bill'
+    | 'bill_payment_check'
+    | 'bill_payment_credit_card'
+    | 'build_assembly'
+    | 'charge'
+    | 'check'
+    | 'credit_card_charge'
+    | 'credit_card_credit'
+    | 'credit_memo'
+    | 'deposit'
+    | 'estimate'
+    | 'inventory_adjustment'
+    | 'invoice'
+    | 'item_receipt'
+    | 'journal_entry'
+    | 'liability_adjustment'
+    | 'paycheck'
+    | 'payroll_liability_check'
+    | 'purchase_order'
+    | 'receive_payment'
+    | 'sales_order'
+    | 'sales_receipt'
+    | 'sales_tax_payment_check'
+    | 'transfer'
+    | 'vendor_credit'
+    | 'ytd_adjustment';
+}
+
+export namespace PaymentToDeposit {
+  /**
+   * The payment to deposit's currency. For built-in currencies, the name and code
+   * are standard ISO 4217 international values. For user-defined currencies, all
+   * values are editable.
+   */
+  export interface Currency {
+    /**
+     * The unique identifier assigned by QuickBooks to this object. This ID is unique
+     * across all objects of the same type, but not across different QuickBooks object
+     * types.
+     */
+    id: string | null;
+
+    /**
+     * The fully-qualified unique name for this object, formed by combining the names
+     * of its parent objects with its own `name`, separated by colons. Not
+     * case-sensitive.
+     */
+    fullName: string | null;
+  }
+
+  /**
+   * The customer or customer-job associated with this payment to deposit.
+   */
+  export interface Customer {
+    /**
+     * The unique identifier assigned by QuickBooks to this object. This ID is unique
+     * across all objects of the same type, but not across different QuickBooks object
+     * types.
+     */
+    id: string | null;
+
+    /**
+     * The fully-qualified unique name for this object, formed by combining the names
+     * of its parent objects with its own `name`, separated by colons. Not
+     * case-sensitive.
+     */
+    fullName: string | null;
+  }
+}
+
+export interface PaymentsToDepositListResponse {
+  /**
+   * The array of payments to deposit.
+   */
+  data: Array<PaymentToDeposit>;
+
+  /**
+   * The type of object. This value is always `"list"`.
+   */
+  objectType: 'list';
+
+  /**
+   * The endpoint URL where this list can be accessed.
+   */
+  url: string;
+}
+
+export interface PaymentsToDepositListParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
+export declare namespace PaymentsToDeposit {
+  export {
+    type PaymentToDeposit as PaymentToDeposit,
+    type PaymentsToDepositListResponse as PaymentsToDepositListResponse,
+    type PaymentsToDepositListParams as PaymentsToDepositListParams,
+  };
+}

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

@@ -74,9 +74,10 @@ export class PriceLevels extends APIResource {
   }
 
   /**
-   * Returns a list of price levels. NOTE: QuickBooks Desktop does not support
-   * pagination for price levels; hence, there is no `cursor` parameter. Users
-   * typically have few price levels.
+   * Returns a list of price levels.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for price levels;
+   * hence, there is no `cursor` parameter. Users typically have few price levels.
    *
    * @example
    * ```ts
@@ -316,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.
@@ -334,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
@@ -427,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.
@@ -445,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

@@ -62,6 +62,10 @@ export class PurchaseOrders extends APIResource {
   /**
    * Updates an existing purchase order.
    *
+   * **NOTE:** If you include `lines` or `lineGroups`, QuickBooks Desktop replaces
+   * each included line list with the array you send, so include unchanged lines you
+   * want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const purchaseOrder =
@@ -1801,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;
 
@@ -1822,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;
 
@@ -1944,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;
 
@@ -2027,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;
 
@@ -2387,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;
 
@@ -2408,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;
 
@@ -2537,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;
 
@@ -2634,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;
 
@@ -2686,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;
 
@@ -2783,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

@@ -204,6 +204,20 @@ import {
   DeletedTransactionListResponse,
   DeletedTransactions,
 } from './deleted-transactions';
+import * as DepositsAPI from './deposits';
+import {
+  Deposit,
+  DepositCreateParams,
+  DepositDeleteParams,
+  DepositDeleteResponse,
+  DepositListParams,
+  DepositRetrieveParams,
+  DepositUpdateParams,
+  DepositVoidParams,
+  DepositVoidResponse,
+  Deposits,
+  DepositsCursorPage,
+} from './deposits';
 import * as DiscountItemsAPI from './discount-items';
 import {
   DiscountItem,
@@ -379,6 +393,13 @@ import {
   PaymentMethodRetrieveParams,
   PaymentMethods,
 } from './payment-methods';
+import * as PaymentsToDepositAPI from './payments-to-deposit';
+import {
+  PaymentToDeposit,
+  PaymentsToDeposit,
+  PaymentsToDepositListParams,
+  PaymentsToDepositListResponse,
+} from './payments-to-deposit';
 import * as PayrollWageItemsAPI from './payroll-wage-items';
 import {
   PayrollWageItem,
@@ -619,6 +640,7 @@ export class Qbd extends APIResource {
   );
   deletedTransactions: DeletedTransactionsAPI.DeletedTransactions =
     new DeletedTransactionsAPI.DeletedTransactions(this._client);
+  deposits: DepositsAPI.Deposits = new DepositsAPI.Deposits(this._client);
   discountItems: DiscountItemsAPI.DiscountItems = new DiscountItemsAPI.DiscountItems(this._client);
   employees: EmployeesAPI.Employees = new EmployeesAPI.Employees(this._client);
   estimates: EstimatesAPI.Estimates = new EstimatesAPI.Estimates(this._client);
@@ -641,6 +663,9 @@ export class Qbd extends APIResource {
   );
   otherNames: OtherNamesAPI.OtherNames = new OtherNamesAPI.OtherNames(this._client);
   paymentMethods: PaymentMethodsAPI.PaymentMethods = new PaymentMethodsAPI.PaymentMethods(this._client);
+  paymentsToDeposit: PaymentsToDepositAPI.PaymentsToDeposit = new PaymentsToDepositAPI.PaymentsToDeposit(
+    this._client,
+  );
   payrollWageItems: PayrollWageItemsAPI.PayrollWageItems = new PayrollWageItemsAPI.PayrollWageItems(
     this._client,
   );
@@ -731,6 +756,7 @@ Qbd.Customers = Customers;
 Qbd.DateDrivenTerms = DateDrivenTerms;
 Qbd.DeletedListObjects = DeletedListObjects;
 Qbd.DeletedTransactions = DeletedTransactions;
+Qbd.Deposits = Deposits;
 Qbd.DiscountItems = DiscountItems;
 Qbd.Employees = Employees;
 Qbd.Estimates = Estimates;
@@ -747,6 +773,7 @@ Qbd.NonInventoryItems = NonInventoryItems;
 Qbd.OtherChargeItems = OtherChargeItems;
 Qbd.OtherNames = OtherNames;
 Qbd.PaymentMethods = PaymentMethods;
+Qbd.PaymentsToDeposit = PaymentsToDeposit;
 Qbd.PayrollWageItems = PayrollWageItems;
 Qbd.PriceLevels = PriceLevels;
 Qbd.PurchaseOrders = PurchaseOrders;
@@ -981,6 +1008,20 @@ export declare namespace Qbd {
     type DeletedTransactionListParams as DeletedTransactionListParams,
   };
 
+  export {
+    Deposits as Deposits,
+    type Deposit as Deposit,
+    type DepositDeleteResponse as DepositDeleteResponse,
+    type DepositVoidResponse as DepositVoidResponse,
+    type DepositsCursorPage as DepositsCursorPage,
+    type DepositCreateParams as DepositCreateParams,
+    type DepositRetrieveParams as DepositRetrieveParams,
+    type DepositUpdateParams as DepositUpdateParams,
+    type DepositListParams as DepositListParams,
+    type DepositDeleteParams as DepositDeleteParams,
+    type DepositVoidParams as DepositVoidParams,
+  };
+
   export {
     DiscountItems as DiscountItems,
     type DiscountItem as DiscountItem,
@@ -1156,6 +1197,13 @@ export declare namespace Qbd {
     type PaymentMethodListParams as PaymentMethodListParams,
   };
 
+  export {
+    PaymentsToDeposit as PaymentsToDeposit,
+    type PaymentToDeposit as PaymentToDeposit,
+    type PaymentsToDepositListResponse as PaymentsToDepositListResponse,
+    type PaymentsToDepositListParams as PaymentsToDepositListParams,
+  };
+
   export {
     PayrollWageItems as PayrollWageItems,
     type PayrollWageItem as PayrollWageItem,