conductor-node 14.9.0 → 14.11.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 =
@@ -136,6 +140,31 @@ export class JournalEntries extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids a journal entry by setting its amount to zero while keeping a record of it
+   * in QuickBooks. The void will fail if the journal entry is currently in use or
+   * has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.journalEntries.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(
+    id: string,
+    params: JournalEntryVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<JournalEntryVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/journal-entries/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type JournalEntriesCursorPage = CursorPage<JournalEntry>;
@@ -640,6 +669,42 @@ export interface JournalEntryDeleteResponse {
   refNumber: string | null;
 }
 
+export interface JournalEntryVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided journal entry.
+   */
+  id: string;
+
+  /**
+   * The date and time when this journal entry was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  createdAt: string | null;
+
+  /**
+   * The type of object. This value is always `"qbd_journal_entry"`.
+   */
+  objectType: 'qbd_journal_entry';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided journal entry.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this journal entry was last updated, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss+hh:mm), which QuickBooks Desktop interprets in the local
+   * timezone of the end-user's computer.
+   */
+  updatedAt: string | null;
+
+  /**
+   * Indicates whether the journal entry was voided.
+   */
+  voided: boolean;
+}
+
 export interface JournalEntryCreateParams {
   /**
    * Body param: The date of this journal entry, in ISO 8601 format (YYYY-MM-DD).
@@ -1115,15 +1180,24 @@ export interface JournalEntryDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface JournalEntryVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace JournalEntries {
   export {
     type JournalEntry as JournalEntry,
     type JournalEntryDeleteResponse as JournalEntryDeleteResponse,
+    type JournalEntryVoidResponse as JournalEntryVoidResponse,
     type JournalEntriesCursorPage as JournalEntriesCursorPage,
     type JournalEntryCreateParams as JournalEntryCreateParams,
     type JournalEntryRetrieveParams as JournalEntryRetrieveParams,
     type JournalEntryUpdateParams as JournalEntryUpdateParams,
     type JournalEntryListParams as JournalEntryListParams,
     type JournalEntryDeleteParams as JournalEntryDeleteParams,
+    type JournalEntryVoidParams as JournalEntryVoidParams,
   };
 }

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

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/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

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 =