conductor-node 14.8.1 → 14.10.0

package/src/resources/qbd/customers.ts

@@ -78,6 +78,9 @@ export class Customers extends APIResource {
    * Returns a list of customers. Use the `cursor` parameter to paginate through the
    * results.
    *
+   * **IMPORTANT**: If this request times out or is slow, set
+   * `excludeAlternateShippingAddresses=true` to significantly improve performance.
+   *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
@@ -139,9 +142,11 @@ export interface Customer {
 
   /**
    * A list of additional shipping addresses for this customer. Useful when the
-   * customer has multiple shipping locations.
+   * customer has multiple shipping locations. If
+   * `excludeAlternateShippingAddresses=true` is set on a customer list request, this
+   * field is `null` because the addresses were not fetched.
    */
-  alternateShippingAddresses: Array<Customer.AlternateShippingAddress>;
+  alternateShippingAddresses: Array<Customer.AlternateShippingAddress> | null;
 
   /**
    * The current balance owed by this customer, excluding balances from any jobs
@@ -2423,6 +2428,16 @@ export interface CustomerListParams extends CursorPageParams {
    */
   currencyIds?: Array<string>;
 
+  /**
+   * Query param: Excludes alternate shipping addresses from each customer returned
+   * by the list request. When true, the response returns
+   * `alternateShippingAddresses` as `null` instead of fetching the address array.
+   * Use this when your integration does not need alternate shipping addresses. This
+   * significantly improves performance for company files where some customers have
+   * many saved shipping addresses (sometimes dozens or hundreds).
+   */
+  excludeAlternateShippingAddresses?: boolean;
+
   /**
    * Query param: Filter for specific customers by their full-name(s),
    * case-insensitive. Like `id`, `fullName` is a unique identifier for a customer,

package/src/resources/qbd/index.ts

@@ -19,32 +19,38 @@ export {
   BillCheckPayments,
   type BillCheckPayment,
   type BillCheckPaymentDeleteResponse,
+  type BillCheckPaymentVoidResponse,
   type BillCheckPaymentCreateParams,
   type BillCheckPaymentRetrieveParams,
   type BillCheckPaymentUpdateParams,
   type BillCheckPaymentListParams,
   type BillCheckPaymentDeleteParams,
+  type BillCheckPaymentVoidParams,
   type BillCheckPaymentsCursorPage,
 } from './bill-check-payments';
 export {
   BillCreditCardPayments,
   type BillCreditCardPayment,
   type BillCreditCardPaymentDeleteResponse,
+  type BillCreditCardPaymentVoidResponse,
   type BillCreditCardPaymentCreateParams,
   type BillCreditCardPaymentRetrieveParams,
   type BillCreditCardPaymentListParams,
   type BillCreditCardPaymentDeleteParams,
+  type BillCreditCardPaymentVoidParams,
   type BillCreditCardPaymentsCursorPage,
 } from './bill-credit-card-payments';
 export {
   Bills,
   type Bill,
   type BillDeleteResponse,
+  type BillVoidResponse,
   type BillCreateParams,
   type BillRetrieveParams,
   type BillUpdateParams,
   type BillListParams,
   type BillDeleteParams,
+  type BillVoidParams,
   type BillsCursorPage,
 } from './bills';
 export {
@@ -62,11 +68,13 @@ export {
   Checks,
   type Check,
   type CheckDeleteResponse,
+  type CheckVoidResponse,
   type CheckCreateParams,
   type CheckRetrieveParams,
   type CheckUpdateParams,
   type CheckListParams,
   type CheckDeleteParams,
+  type CheckVoidParams,
   type ChecksCursorPage,
 } from './checks';
 export {
@@ -83,43 +91,51 @@ export {
   CreditCardCharges,
   type CreditCardCharge,
   type CreditCardChargeDeleteResponse,
+  type CreditCardChargeVoidResponse,
   type CreditCardChargeCreateParams,
   type CreditCardChargeRetrieveParams,
   type CreditCardChargeUpdateParams,
   type CreditCardChargeListParams,
   type CreditCardChargeDeleteParams,
+  type CreditCardChargeVoidParams,
   type CreditCardChargesCursorPage,
 } from './credit-card-charges';
 export {
   CreditCardCredits,
   type CreditCardCredit,
   type CreditCardCreditDeleteResponse,
+  type CreditCardCreditVoidResponse,
   type CreditCardCreditCreateParams,
   type CreditCardCreditRetrieveParams,
   type CreditCardCreditUpdateParams,
   type CreditCardCreditListParams,
   type CreditCardCreditDeleteParams,
+  type CreditCardCreditVoidParams,
   type CreditCardCreditsCursorPage,
 } from './credit-card-credits';
 export {
   CreditCardRefunds,
   type CreditCardRefund,
   type CreditCardRefundDeleteResponse,
+  type CreditCardRefundVoidResponse,
   type CreditCardRefundCreateParams,
   type CreditCardRefundRetrieveParams,
   type CreditCardRefundListParams,
   type CreditCardRefundDeleteParams,
+  type CreditCardRefundVoidParams,
   type CreditCardRefundsCursorPage,
 } from './credit-card-refunds';
 export {
   CreditMemos,
   type CreditMemo,
   type CreditMemoDeleteResponse,
+  type CreditMemoVoidResponse,
   type CreditMemoCreateParams,
   type CreditMemoRetrieveParams,
   type CreditMemoUpdateParams,
   type CreditMemoListParams,
   type CreditMemoDeleteParams,
+  type CreditMemoVoidParams,
   type CreditMemosCursorPage,
 } from './credit-memos';
 export {
@@ -202,11 +218,13 @@ export {
   type InventoryAdjustment,
   type InventoryAdjustmentListResponse,
   type InventoryAdjustmentDeleteResponse,
+  type InventoryAdjustmentVoidResponse,
   type InventoryAdjustmentCreateParams,
   type InventoryAdjustmentRetrieveParams,
   type InventoryAdjustmentUpdateParams,
   type InventoryAdjustmentListParams,
   type InventoryAdjustmentDeleteParams,
+  type InventoryAdjustmentVoidParams,
 } from './inventory-adjustments';
 export {
   InventoryAssemblyItems,
@@ -239,11 +257,13 @@ export {
   Invoices,
   type Invoice,
   type InvoiceDeleteResponse,
+  type InvoiceVoidResponse,
   type InvoiceCreateParams,
   type InvoiceRetrieveParams,
   type InvoiceUpdateParams,
   type InvoiceListParams,
   type InvoiceDeleteParams,
+  type InvoiceVoidParams,
   type InvoicesCursorPage,
 } from './invoices';
 export {
@@ -259,11 +279,13 @@ export {
   ItemReceipts,
   type ItemReceipt,
   type ItemReceiptDeleteResponse,
+  type ItemReceiptVoidResponse,
   type ItemReceiptCreateParams,
   type ItemReceiptRetrieveParams,
   type ItemReceiptUpdateParams,
   type ItemReceiptListParams,
   type ItemReceiptDeleteParams,
+  type ItemReceiptVoidParams,
   type ItemReceiptsCursorPage,
 } from './item-receipts';
 export {
@@ -277,11 +299,13 @@ export {
   JournalEntries,
   type JournalEntry,
   type JournalEntryDeleteResponse,
+  type JournalEntryVoidResponse,
   type JournalEntryCreateParams,
   type JournalEntryRetrieveParams,
   type JournalEntryUpdateParams,
   type JournalEntryListParams,
   type JournalEntryDeleteParams,
+  type JournalEntryVoidParams,
   type JournalEntriesCursorPage,
 } from './journal-entries';
 export {
@@ -375,11 +399,13 @@ export {
   SalesReceipts,
   type SalesReceipt,
   type SalesReceiptDeleteResponse,
+  type SalesReceiptVoidResponse,
   type SalesReceiptCreateParams,
   type SalesReceiptRetrieveParams,
   type SalesReceiptUpdateParams,
   type SalesReceiptListParams,
   type SalesReceiptDeleteParams,
+  type SalesReceiptVoidParams,
   type SalesReceiptsCursorPage,
 } from './sales-receipts';
 export {
@@ -483,11 +509,13 @@ export {
   VendorCredits,
   type VendorCredit,
   type VendorCreditDeleteResponse,
+  type VendorCreditVoidResponse,
   type VendorCreditCreateParams,
   type VendorCreditRetrieveParams,
   type VendorCreditUpdateParams,
   type VendorCreditListParams,
   type VendorCreditDeleteParams,
+  type VendorCreditVoidParams,
   type VendorCreditsCursorPage,
 } from './vendor-credits';
 export {

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

@@ -138,6 +138,32 @@ export class InventoryAdjustments extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids an inventory adjustment by setting its amount to zero while keeping a
+   * record of it in QuickBooks. The void will fail if the inventory adjustment is
+   * currently in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await conductor.qbd.inventoryAdjustments.void(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
+   */
+  void(
+    id: string,
+    params: InventoryAdjustmentVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<InventoryAdjustmentVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/inventory-adjustments/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export interface InventoryAdjustment {
@@ -506,6 +532,43 @@ export interface InventoryAdjustmentDeleteResponse {
   refNumber: string | null;
 }
 
+export interface InventoryAdjustmentVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided inventory adjustment.
+   */
+  id: string;
+
+  /**
+   * The date and time when this inventory adjustment 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_inventory_adjustment"`.
+   */
+  objectType: 'qbd_inventory_adjustment';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided inventory
+   * adjustment.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this inventory adjustment 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 inventory adjustment was voided.
+   */
+  voided: boolean;
+}
+
 export interface InventoryAdjustmentCreateParams {
   /**
    * Body param: The account to which this inventory adjustment is posted for
@@ -1072,15 +1135,24 @@ export interface InventoryAdjustmentDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface InventoryAdjustmentVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace InventoryAdjustments {
   export {
     type InventoryAdjustment as InventoryAdjustment,
     type InventoryAdjustmentListResponse as InventoryAdjustmentListResponse,
     type InventoryAdjustmentDeleteResponse as InventoryAdjustmentDeleteResponse,
+    type InventoryAdjustmentVoidResponse as InventoryAdjustmentVoidResponse,
     type InventoryAdjustmentCreateParams as InventoryAdjustmentCreateParams,
     type InventoryAdjustmentRetrieveParams as InventoryAdjustmentRetrieveParams,
     type InventoryAdjustmentUpdateParams as InventoryAdjustmentUpdateParams,
     type InventoryAdjustmentListParams as InventoryAdjustmentListParams,
     type InventoryAdjustmentDeleteParams as InventoryAdjustmentDeleteParams,
+    type InventoryAdjustmentVoidParams as InventoryAdjustmentVoidParams,
   };
 }

package/src/resources/qbd/invoices.ts

@@ -124,6 +124,27 @@ export class Invoices extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids an invoice by setting its amount to zero while keeping a record of it in
+   * QuickBooks. The void will fail if the invoice is currently in use or has any
+   * linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.invoices.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(id: string, params: InvoiceVoidParams, options?: RequestOptions): APIPromise<InvoiceVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/invoices/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type InvoicesCursorPage = CursorPage<Invoice>;
@@ -1760,6 +1781,42 @@ export interface InvoiceDeleteResponse {
   refNumber: string | null;
 }
 
+export interface InvoiceVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided invoice.
+   */
+  id: string;
+
+  /**
+   * The date and time when this invoice 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_invoice"`.
+   */
+  objectType: 'qbd_invoice';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided invoice.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this invoice 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 invoice was voided.
+   */
+  voided: boolean;
+}
+
 export interface InvoiceCreateParams {
   /**
    * Body param: The customer or customer-job associated with this invoice.
@@ -3464,15 +3521,24 @@ export interface InvoiceDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface InvoiceVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace Invoices {
   export {
     type Invoice as Invoice,
     type InvoiceDeleteResponse as InvoiceDeleteResponse,
+    type InvoiceVoidResponse as InvoiceVoidResponse,
     type InvoicesCursorPage as InvoicesCursorPage,
     type InvoiceCreateParams as InvoiceCreateParams,
     type InvoiceRetrieveParams as InvoiceRetrieveParams,
     type InvoiceUpdateParams as InvoiceUpdateParams,
     type InvoiceListParams as InvoiceListParams,
     type InvoiceDeleteParams as InvoiceDeleteParams,
+    type InvoiceVoidParams as InvoiceVoidParams,
   };
 }

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

@@ -132,6 +132,31 @@ export class ItemReceipts extends APIResource {
       headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
     });
   }
+
+  /**
+   * Voids an item receipt by setting its amount to zero while keeping a record of it
+   * in QuickBooks. The void will fail if the item receipt is currently in use or has
+   * any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const response = await conductor.qbd.itemReceipts.void(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
+   */
+  void(
+    id: string,
+    params: ItemReceiptVoidParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemReceiptVoidResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.post(path`/quickbooks-desktop/item-receipts/${id}/void`, {
+      ...options,
+      headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
+    });
+  }
 }
 
 export type ItemReceiptsCursorPage = CursorPage<ItemReceipt>;
@@ -1625,6 +1650,42 @@ export interface ItemReceiptDeleteResponse {
   refNumber: string | null;
 }
 
+export interface ItemReceiptVoidResponse {
+  /**
+   * The QuickBooks-assigned unique identifier of the voided item receipt.
+   */
+  id: string;
+
+  /**
+   * The date and time when this item receipt 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_item_receipt"`.
+   */
+  objectType: 'qbd_item_receipt';
+
+  /**
+   * The case-sensitive user-defined reference number of the voided item receipt.
+   */
+  refNumber: string | null;
+
+  /**
+   * The date and time when this item receipt 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 item receipt was voided.
+   */
+  voided: boolean;
+}
+
 export interface ItemReceiptCreateParams {
   /**
    * Body param: The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).
@@ -2843,15 +2904,24 @@ export interface ItemReceiptDeleteParams {
   conductorEndUserId: string;
 }
 
+export interface ItemReceiptVoidParams {
+  /**
+   * The ID of the End-User to receive this request.
+   */
+  conductorEndUserId: string;
+}
+
 export declare namespace ItemReceipts {
   export {
     type ItemReceipt as ItemReceipt,
     type ItemReceiptDeleteResponse as ItemReceiptDeleteResponse,
+    type ItemReceiptVoidResponse as ItemReceiptVoidResponse,
     type ItemReceiptsCursorPage as ItemReceiptsCursorPage,
     type ItemReceiptCreateParams as ItemReceiptCreateParams,
     type ItemReceiptRetrieveParams as ItemReceiptRetrieveParams,
     type ItemReceiptUpdateParams as ItemReceiptUpdateParams,
     type ItemReceiptListParams as ItemReceiptListParams,
     type ItemReceiptDeleteParams as ItemReceiptDeleteParams,
+    type ItemReceiptVoidParams as ItemReceiptVoidParams,
   };
 }

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

@@ -136,6 +136,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 +665,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 +1176,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,
   };
 }