qubesync 0.1.0 → 0.2.0

package/operations/bill_to_pay.d.ts

@@ -0,0 +1,54 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, CurrencyFilter, CurrencyRef } from "./types";
+
+/** QuickBooks bill to pay operations: `qube.billToPay.<action>(connectionId, params, { webhookUrl })`. */
+export declare class BillToPay {
+  constructor(client: Client);
+  /**
+   * List bill to pays: `GET /connections/{connection_id}/bill-to-pays`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `ap_account_ref`, `currency_filter`, `due_date`, `include_ret_element`, `meta_data`, `payee_entity_ref` (required), `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/bill-to-pays/list-bill-to-pays
+   */
+  query(connectionId: string, params: BillToPayQueryParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `bill_to_pay.query`: List bill to pays.
+ */
+export interface BillToPayQueryParams {
+  /**
+   * Refers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.) If `ap_account_ref` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `ap_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
+   */
+  ap_account_ref?: CurrencyRef;
+  /**
+   * Filters by the specified currency.
+   */
+  currency_filter?: CurrencyFilter;
+  /**
+   * The date on which payment is due.
+   *
+   * Format: date.
+   */
+  due_date?: string;
+  include_ret_element?: Array<"BillToPay" | "CreditToApply">;
+  /**
+   * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
+   */
+  meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
+  /**
+   * `payee_entity_ref` identifies the payee (customer, vendor, employee, or Other Name). If both `full_name` and `list_id` are provided, `full_name` is ignored.
+   */
+  payee_entity_ref: CurrencyRef;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+}

package/operations/bill_to_pay.js

@@ -0,0 +1,26 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks bill to pay operations. Types: bill_to_pay.d.ts. */
+class BillToPay {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * List bill to pays.
+   * @param {string} connectionId
+   * @param {import("./bill_to_pay").BillToPayQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/bill-to-pays/list-bill-to-pays
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("bill_to_pay.query", connectionId, params, options);
+  }
+}
+
+module.exports = { BillToPay };

package/operations/billing_rate.d.ts

@@ -0,0 +1,159 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, CurrencyRef, NameFilter, NameRangeFilter } from "./types";
+
+/** QuickBooks billing rate operations: `qube.billingRate.<action>(connectionId, params, { webhookUrl })`. */
+export declare class BillingRate {
+  constructor(client: Client);
+  /**
+   * Create billing rate: `POST /connections/{connection_id}/billing-rates`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `billing_rate_per_item`, `fixed_billing_rate`, `include_ret_element`, `name` (required), `request_id`.
+   *
+   * Give exactly one of: `fixed_billing_rate`, or `billing_rate_per_item`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/billing-rates/create-billing-rate
+   */
+  create(connectionId: string, params: BillingRateCreateParams, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List billing rates: `GET /connections/{connection_id}/billing-rates`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `from_modified_date`, `full_name`, `include_ret_element`, `item_ref`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `request_id`, `to_modified_date`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/billing-rates/list-billing-rates
+   */
+  query(connectionId: string, params: BillingRateQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `billing_rate.create`: Create billing rate.
+ *
+ * Give exactly one of: `fixed_billing_rate`, or `billing_rate_per_item`.
+ */
+export interface BillingRateCreateParams {
+  billing_rate_per_item?: BillingRatePerItem[];
+  /**
+   * You use `fixed_billing_rate` if you want the rate to override all service items rates. Consequently, there is no need to specify any service items (and in fact you can’t specify them) if you use this element.
+   */
+  fixed_billing_rate?: number;
+  include_ret_element?: Array<"BillingRatePerItemRet" | "BillingRateType" | "EditSequence" | "ExternalGUID" | "FixedBillingRate" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
+  /**
+   * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct.
+   */
+  name: string;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+}
+
+/**
+ * The params of `billing_rate.query`: List billing rates.
+ */
+export interface BillingRateQueryParams {
+  /**
+   * Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Format: date-time.
+   */
+  from_modified_date?: string;
+  /**
+   * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  full_name?: string[];
+  include_ret_element?: Array<"BillingRatePerItemRet" | "BillingRateType" | "EditSequence" | "FixedBillingRate" | "ListID" | "Name" | "TimeCreated" | "TimeModified">;
+  /**
+   * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  item_ref?: CurrencyRef;
+  /**
+   * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  list_id?: string[];
+  /**
+   * Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1.
+   *
+   * QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Minimum 1.
+   */
+  max_returned?: number;
+  /**
+   * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
+   */
+  meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
+  /**
+   * Filters according to the object’s Name.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  name_filter?: NameFilter;
+  /**
+   * Filters according to the object’s Name.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  name_range_filter?: NameRangeFilter;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59).
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`from_modified_date`, `item_ref`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Format: date-time.
+   */
+  to_modified_date?: string;
+}
+
+export interface BillingRatePerItem {
+  /**
+   * Specifies the service item rate that `adjust_percentage` is applied to. Normally, this is set to StandardRate.
+   *
+   * Choose exactly one of: the set (`custom_rate`, `custom_rate_percent`), or the set (`adjust_billing_rate_relative_to`, `adjust_percentage`). Members of a set combine with each other, not with the other choices.
+   */
+  adjust_billing_rate_relative_to?: "CurrentCustomRate" | "StandardRate";
+  /**
+   * If you don’t want to apply a custom price (for price levels) or custom rate (for billing rates), you can apply an adjusted price discount using the pair of fields `adjust_percentage` and AdjustRelativeTo (`adjust_billing_rate_relative_to` for billing rates).
+   *
+   * Choose exactly one of: the set (`custom_rate`, `custom_rate_percent`), or the set (`adjust_billing_rate_relative_to`, `adjust_percentage`). Members of a set combine with each other, not with the other choices.
+   */
+  adjust_percentage?: number;
+  /**
+   * The value specified here overrides the rate of the service item referenced in this aggregate (in the `item_ref`) with the rate you specify here. If instead you wanted a rate that is a percentage higher or lower than the service item rate, you wouldn’t use `custom_rate`, but you would use `adjust_percentage` and `adjust_billing_rate_relative_to`.
+   *
+   * Choose exactly one of: the set (`custom_rate`, `custom_rate_percent`), or the set (`adjust_billing_rate_relative_to`, `adjust_percentage`). Members of a set combine with each other, not with the other choices.
+   */
+  custom_rate?: number;
+  /**
+   * Using this field with BillingRateAdd will work only if the service item itself is set to a percentage, not to an amount. If you attempt to set the Billing Rate to a percentage for a service item that has an amount for the Rate, you will get an error. The kind of rate you have on the service item determines the kind of billing rate you may have on that item.
+   *
+   * Choose exactly one of: the set (`custom_rate`, `custom_rate_percent`), or the set (`adjust_billing_rate_relative_to`, `adjust_percentage`). Members of a set combine with each other, not with the other choices.
+   */
+  custom_rate_percent?: number;
+  /**
+   * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
+   */
+  item_ref: CurrencyRef;
+}

package/operations/billing_rate.js

@@ -0,0 +1,38 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks billing rate operations. Types: billing_rate.d.ts. */
+class BillingRate {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * Create billing rate.
+   * @param {string} connectionId
+   * @param {import("./billing_rate").BillingRateCreateParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/billing-rates/create-billing-rate
+   */
+  create(connectionId, params, options) {
+    return this.#client.queue("billing_rate.create", connectionId, params, options);
+  }
+
+  /**
+   * List billing rates.
+   * @param {string} connectionId
+   * @param {import("./billing_rate").BillingRateQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/billing-rates/list-billing-rates
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("billing_rate.query", connectionId, params, options);
+  }
+}
+
+module.exports = { BillingRate };

package/operations/budget_summary_report.d.ts

@@ -0,0 +1,71 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, ReportClassFilter, ReportPeriod } from "./types";
+
+/** QuickBooks budget summary report operations: `qube.budgetSummaryReport.<action>(connectionId, params, { webhookUrl })`. */
+export declare class BudgetSummaryReport {
+  constructor(client: Client);
+  /**
+   * List budget summary reports: `GET /connections/{connection_id}/budget-summary-reports`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `budget_criterion`, `budget_summary_report_type` (required), `display_report`, `fiscal_year` (required), `report_class_filter`, `report_date_macro`, `report_period`, `request_id`, `summarize_budget_columns_by`, `summarize_budget_rows_by`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/budget-summary-reports/list-budget-summary-reports
+   */
+  query(connectionId: string, params: BudgetSummaryReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `budget_summary_report.query`: List budget summary reports.
+ */
+export interface BudgetSummaryReportQueryParams {
+  /**
+   * What this budget covers.
+   */
+  budget_criterion?: "Accounts" | "AccountsAndClasses" | "AccountsAndCustomers";
+  /**
+   * The type of budget report being queried.
+   */
+  budget_summary_report_type: "BalanceSheetBudgetOverview" | "BalanceSheetBudgetVsActual" | "ProfitAndLossBudgetOverview" | "ProfitAndLossBudgetPerformance" | "ProfitAndLossBudgetVsActual";
+  /**
+   * Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
+   */
+  display_report?: boolean;
+  /**
+   * Specify the fiscal year of the budget to be queried. There can only be one balance sheet budget for each fiscal year, one profit and loss (P&L) by account budget per fiscal year, and one profit and loss (P&L) by account and customer budget per fiscal year. When Fiscal year isn’t the current year, the report returns the data for the full fiscal year.
+   */
+  fiscal_year: number;
+  /**
+   * Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
+   */
+  report_class_filter?: ReportClassFilter;
+  /**
+   * The time period covered by this report.
+   *
+   * Choose at most one of: `report_period`, or `report_date_macro`.
+   */
+  report_date_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
+  /**
+   * If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
+   *
+   * Choose at most one of: `report_period`, or `report_date_macro`.
+   */
+  report_period?: ReportPeriod;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * `summarize_budget_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report.
+   */
+  summarize_budget_columns_by?: "Class" | "Customer" | "Date";
+  /**
+   * How you want rows to be labeled in the report. For example, if you set the value to sbrbAccount, the report’s row labels might be “Checking,” “Savings,” and so on.
+   */
+  summarize_budget_rows_by?: "Account" | "Class" | "Customer";
+}

package/operations/budget_summary_report.js

@@ -0,0 +1,26 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks budget summary report operations. Types: budget_summary_report.d.ts. */
+class BudgetSummaryReport {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * List budget summary reports.
+   * @param {string} connectionId
+   * @param {import("./budget_summary_report").BudgetSummaryReportQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/budget-summary-reports/list-budget-summary-reports
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("budget_summary_report.query", connectionId, params, options);
+  }
+}
+
+module.exports = { BudgetSummaryReport };

package/operations/build_assembly.d.ts

@@ -0,0 +1,264 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, AccountFilter, CurrencyRef, ModifiedDateRangeFilter, RefNumberFilter, RefNumberRangeFilter, TxnDateRangeFilter } from "./types";
+
+/** QuickBooks build assembly operations: `qube.buildAssembly.<action>(connectionId, params, { webhookUrl })`. */
+export declare class BuildAssembly {
+  constructor(client: Client);
+  /**
+   * Create build assembly: `POST /connections/{connection_id}/build-assemblies`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `def_macro`, `external_guid`, `include_ret_element`, `inventory_site_location_ref`, `inventory_site_ref`, `item_inventory_assembly_ref` (required), `lot_number`, `mark_pending_if_required`, `memo`, `quantity_to_build` (required), `ref_number`, `request_id`, `serial_number`, `txn_date`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/build-assemblies/create-build-assembly
+   */
+  create(connectionId: string, params: BuildAssemblyCreateParams, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List build assemblies: `GET /connections/{connection_id}/build-assemblies`, queued for QuickBooks.
+   *
+   * QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
+   * Params go in the query string.
+   *
+   * Fields: `include_component_line_items`, `include_ret_element`, `item_filter`, `iterator`, `max_returned`, `meta_data`, `modified_date_range_filter`, `owner_id`, `pending_status`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/build-assemblies/list-build-assemblies
+   */
+  query(connectionId: string, params: BuildAssemblyQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * Update build assembly: `PUT /connections/{connection_id}/build-assemblies`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `edit_sequence` (required), `include_ret_element`, `inventory_site_location_ref`, `inventory_site_ref`, `lot_number`, `mark_pending_if_required`, `memo`, `quantity_to_build`, `ref_number`, `remove_pending`, `request_id`, `serial_number`, `txn_date`, `txn_id` (required).
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/build-assemblies/update-build-assembly
+   */
+  update(connectionId: string, params: BuildAssemblyUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `build_assembly.create`: Create build assembly.
+ */
+export interface BuildAssemblyCreateParams {
+  /**
+   * `def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
+   */
+  def_macro?: string;
+  /**
+   * Allows for the attachment of a user defined GUID value.
+   */
+  external_guid?: string;
+  include_ret_element?: Array<"ComponentItemLineRet" | "DataExtRet" | "EditSequence" | "ExpirationDateForSerialLotNumber" | "ExternalGUID" | "InventorySiteLocationRef" | "InventorySiteRef" | "IsPending" | "ItemInventoryAssemblyRef" | "ListID" | "LotNumber" | "Memo" | "OwnerID" | "QuantityCanBuild" | "QuantityOnHand" | "QuantityOnSalesOrder" | "QuantityToBuild" | "RefNumber" | "SerialNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
+  /**
+   * Location within the Inventory Site
+   */
+  inventory_site_location_ref?: CurrencyRef;
+  /**
+   * Site where inventory is located.
+   */
+  inventory_site_ref?: CurrencyRef;
+  /**
+   * An inventory assembly item is one that is assembled or manufactured from inventory items. The items and/or assemblies that make up the assembly are called components. For Premier, an assembly can have a maximum of 100 components. For Enterprise, the maximum is 500 components.
+   */
+  item_inventory_assembly_ref: CurrencyRef;
+  /**
+   * The lot number of the asset.
+   *
+   * Choose at most one of: `serial_number`, or `lot_number`.
+   */
+  lot_number?: string;
+  /**
+   * Allows the build assembly to be marked pending if there are insufficient quantities to complete the build assembly.
+   */
+  mark_pending_if_required?: boolean;
+  /**
+   * Additional information.
+   */
+  memo?: string;
+  /**
+   * Specifies the number of assemblies to be built. The transaction will fail if the number specified here exceeds the number of on-hand components.
+   */
+  quantity_to_build: number;
+  /**
+   * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
+   */
+  ref_number?: string;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * The serial number of the asset.
+   *
+   * Choose at most one of: `serial_number`, or `lot_number`.
+   */
+  serial_number?: string;
+  /**
+   * The date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
+   *
+   * Format: date.
+   */
+  txn_date?: string;
+}
+
+/**
+ * The params of `build_assembly.query`: List build assemblies.
+ */
+export interface BuildAssemblyQueryParams {
+  /**
+   * Specify “true” if component line items for each returned transaction are to be included in the returned data. Specify “false” if the line items aren’t be returned.
+   */
+  include_component_line_items?: boolean;
+  include_ret_element?: Array<"ComponentItemLineRet" | "DataExtRet" | "EditSequence" | "ExpirationDateForSerialLotNumber" | "ExternalGUID" | "InventorySiteLocationRef" | "InventorySiteRef" | "IsPending" | "ItemInventoryAssemblyRef" | "LotNumber" | "Memo" | "QuantityCanBuild" | "QuantityOnHand" | "QuantityOnSalesOrder" | "QuantityToBuild" | "RefNumber" | "SerialNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
+  /**
+   * Filters according to the item name or ID. You can use an ItemQuery request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  item_filter?: AccountFilter;
+  /**
+   * Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records; send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `ref_number`, `ref_number_case_sensitive` or `txn_id` every match comes back in one answer, so leave `iterator` out.
+   */
+  iterator?: boolean;
+  /**
+   * Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1.
+   *
+   * The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   *
+   * Minimum 1.
+   */
+  max_returned?: number;
+  /**
+   * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
+   */
+  meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
+  /**
+   * Filters according to the dates when transactions were last modified. The `modified_date_range_filter` aggregate isn’t required to contain any elements, but if it is empty, we recommend that you leave it out altogether.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  modified_date_range_filter?: ModifiedDateRangeFilter;
+  /**
+   * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
+   */
+  owner_id?: string[];
+  /**
+   * Specifies whether the transaction is pending (posted) or not.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  pending_status?: "All" | "NotPendingOnly" | "PendingOnly";
+  /**
+   * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number?: string[];
+  /**
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number_case_sensitive?: string[];
+  /**
+   * Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number_filter?: RefNumberFilter;
+  /**
+   * Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number_range_filter?: RefNumberRangeFilter;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * Filters according to the original transaction dates.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  txn_date_range_filter?: TxnDateRangeFilter;
+  /**
+   * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
+   *
+   * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`item_filter`, `max_returned`, `modified_date_range_filter`, `pending_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  txn_id?: string[];
+}
+
+/**
+ * The params of `build_assembly.update`: Update build assembly.
+ */
+export interface BuildAssemblyUpdateParams {
+  /**
+   * `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes.
+   */
+  edit_sequence: string;
+  include_ret_element?: Array<"ComponentItemLineRet" | "DataExtRet" | "EditSequence" | "ExpirationDateForSerialLotNumber" | "ExternalGUID" | "InventorySiteLocationRef" | "InventorySiteRef" | "IsPending" | "ItemInventoryAssemblyRef" | "ListID" | "LotNumber" | "Memo" | "OwnerID" | "QuantityCanBuild" | "QuantityOnHand" | "QuantityOnSalesOrder" | "QuantityToBuild" | "RefNumber" | "SerialNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
+  /**
+   * Location within the Inventory Site
+   */
+  inventory_site_location_ref?: CurrencyRef;
+  /**
+   * Site where inventory is located.
+   */
+  inventory_site_ref?: CurrencyRef;
+  /**
+   * The lot number of the asset.
+   *
+   * Choose at most one of: `serial_number`, or `lot_number`.
+   */
+  lot_number?: string;
+  /**
+   * Allows the build assembly to be marked pending if there are insufficient quantities to complete the build assembly.
+   */
+  mark_pending_if_required?: boolean;
+  /**
+   * Additional information.
+   */
+  memo?: string;
+  /**
+   * Specifies the number of assemblies to be built. The transaction will fail if the number specified here exceeds the number of on-hand components.
+   */
+  quantity_to_build?: number;
+  /**
+   * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
+   */
+  ref_number?: string;
+  /**
+   * Changes the transaction’s pending status from Pending to non pending. In BuildAssembly transactions, this effectively does the build transaction. Hence, removing the Pending status will fail if there aren’t enough components on hand for the build.
+   */
+  remove_pending?: boolean;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * The serial number of the asset.
+   *
+   * Choose at most one of: `serial_number`, or `lot_number`.
+   */
+  serial_number?: string;
+  /**
+   * The date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
+   *
+   * Format: date.
+   */
+  txn_date?: string;
+  /**
+   * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
+   */
+  txn_id: string;
+}