qubesync 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -2
- package/README.md +188 -5
- package/client.js +660 -0
- package/index.d.ts +211 -1
- package/index.js +5 -1
- package/index.mjs +2 -0
- package/operations/account.d.ts +263 -0
- package/operations/account.js +50 -0
- package/operations/account_tax_line_info.d.ts +31 -0
- package/operations/account_tax_line_info.js +26 -0
- package/operations/aging_report.d.ts +100 -0
- package/operations/aging_report.js +26 -0
- package/operations/alert.d.ts +118 -0
- package/operations/alert.js +50 -0
- package/operations/ar_refund_credit_card.d.ts +201 -0
- package/operations/ar_refund_credit_card.js +38 -0
- package/operations/bar_code.d.ts +40 -0
- package/operations/bar_code.js +26 -0
- package/operations/bill.d.ts +612 -0
- package/operations/bill.js +50 -0
- package/operations/bill_payment_check.d.ts +276 -0
- package/operations/bill_payment_check.js +50 -0
- package/operations/bill_payment_credit_card.d.ts +178 -0
- package/operations/bill_payment_credit_card.js +38 -0
- package/operations/bill_to_pay.d.ts +54 -0
- package/operations/bill_to_pay.js +26 -0
- package/operations/billing_rate.d.ts +159 -0
- package/operations/billing_rate.js +38 -0
- package/operations/budget_summary_report.d.ts +71 -0
- package/operations/budget_summary_report.js +26 -0
- package/operations/build_assembly.d.ts +264 -0
- package/operations/build_assembly.js +50 -0
- package/operations/charge.d.ts +330 -0
- package/operations/charge.js +50 -0
- package/operations/check.d.ts +394 -0
- package/operations/check.js +50 -0
- package/operations/class.d.ts +170 -0
- package/operations/class.js +50 -0
- package/operations/cleared_status.d.ts +43 -0
- package/operations/cleared_status.js +26 -0
- package/operations/client.d.ts +254 -0
- package/operations/company.d.ts +36 -0
- package/operations/company.js +26 -0
- package/operations/company_activity.d.ts +32 -0
- package/operations/company_activity.js +26 -0
- package/operations/credit_card_charge.d.ts +280 -0
- package/operations/credit_card_charge.js +50 -0
- package/operations/credit_card_credit.d.ts +280 -0
- package/operations/credit_card_credit.js +50 -0
- package/operations/credit_memo.d.ts +642 -0
- package/operations/credit_memo.js +50 -0
- package/operations/currency.d.ts +195 -0
- package/operations/currency.js +50 -0
- package/operations/custom_detail_report.d.ts +108 -0
- package/operations/custom_detail_report.js +26 -0
- package/operations/custom_summary_report.d.ts +119 -0
- package/operations/custom_summary_report.js +26 -0
- package/operations/customer.d.ts +639 -0
- package/operations/customer.js +50 -0
- package/operations/customer_msg.d.ts +121 -0
- package/operations/customer_msg.js +38 -0
- package/operations/customer_type.d.ts +127 -0
- package/operations/customer_type.js +38 -0
- package/operations/data_event_recovery_info.d.ts +61 -0
- package/operations/data_event_recovery_info.js +38 -0
- package/operations/data_ext.d.ts +197 -0
- package/operations/data_ext.js +50 -0
- package/operations/data_ext_def.d.ts +173 -0
- package/operations/data_ext_def.js +62 -0
- package/operations/date_driven_terms.d.ts +141 -0
- package/operations/date_driven_terms.js +38 -0
- package/operations/deposit.d.ts +402 -0
- package/operations/deposit.js +50 -0
- package/operations/employee.d.ts +683 -0
- package/operations/employee.js +50 -0
- package/operations/employee_default.d.ts +133 -0
- package/operations/employee_default.js +38 -0
- package/operations/entity.d.ts +96 -0
- package/operations/entity.js +26 -0
- package/operations/estimate.d.ts +590 -0
- package/operations/estimate.js +50 -0
- package/operations/form1099_category_account_mapping.d.ts +89 -0
- package/operations/form1099_category_account_mapping.js +38 -0
- package/operations/general_detail_report.d.ts +108 -0
- package/operations/general_detail_report.js +26 -0
- package/operations/general_summary_report.d.ts +115 -0
- package/operations/general_summary_report.js +26 -0
- package/operations/host.d.ts +43 -0
- package/operations/host.js +26 -0
- package/operations/index.js +397 -0
- package/operations/inventory_adjustment.d.ts +389 -0
- package/operations/inventory_adjustment.js +50 -0
- package/operations/inventory_site.d.ts +247 -0
- package/operations/inventory_site.js +50 -0
- package/operations/invoice.d.ts +682 -0
- package/operations/invoice.js +50 -0
- package/operations/item.d.ts +100 -0
- package/operations/item.js +26 -0
- package/operations/item_assemblies_can_build.d.ts +41 -0
- package/operations/item_assemblies_can_build.js +26 -0
- package/operations/item_discount.d.ts +256 -0
- package/operations/item_discount.js +50 -0
- package/operations/item_fixed_asset.d.ts +382 -0
- package/operations/item_fixed_asset.js +50 -0
- package/operations/item_group.d.ts +236 -0
- package/operations/item_group.js +50 -0
- package/operations/item_inventory.d.ts +350 -0
- package/operations/item_inventory.js +50 -0
- package/operations/item_inventory_assembly.d.ts +368 -0
- package/operations/item_inventory_assembly.js +50 -0
- package/operations/item_non_inventory.d.ts +264 -0
- package/operations/item_non_inventory.js +50 -0
- package/operations/item_other_charge.d.ts +244 -0
- package/operations/item_other_charge.js +50 -0
- package/operations/item_payment.d.ts +220 -0
- package/operations/item_payment.js +50 -0
- package/operations/item_receipt.d.ts +362 -0
- package/operations/item_receipt.js +50 -0
- package/operations/item_sales_tax.d.ts +228 -0
- package/operations/item_sales_tax.js +50 -0
- package/operations/item_sales_tax_group.d.ts +192 -0
- package/operations/item_sales_tax_group.js +50 -0
- package/operations/item_service.d.ts +256 -0
- package/operations/item_service.js +50 -0
- package/operations/item_sites.d.ts +81 -0
- package/operations/item_sites.js +26 -0
- package/operations/item_subtotal.d.ts +188 -0
- package/operations/item_subtotal.js +50 -0
- package/operations/job_report.d.ts +99 -0
- package/operations/job_report.js +26 -0
- package/operations/job_type.d.ts +127 -0
- package/operations/job_type.js +38 -0
- package/operations/journal_entry.d.ts +339 -0
- package/operations/journal_entry.js +50 -0
- package/operations/lead.d.ts +291 -0
- package/operations/lead.js +50 -0
- package/operations/list.d.ts +39 -0
- package/operations/list.js +26 -0
- package/operations/list_deleted.d.ts +44 -0
- package/operations/list_deleted.js +26 -0
- package/operations/list_display.d.ts +65 -0
- package/operations/list_display.js +38 -0
- package/operations/list_merge.d.ts +58 -0
- package/operations/list_merge.js +26 -0
- package/operations/other_name.d.ts +280 -0
- package/operations/other_name.js +50 -0
- package/operations/paycheck.d.ts +82 -0
- package/operations/paycheck.js +26 -0
- package/operations/payment_method.d.ts +131 -0
- package/operations/payment_method.js +38 -0
- package/operations/payroll_detail_report.d.ts +97 -0
- package/operations/payroll_detail_report.js +26 -0
- package/operations/payroll_item.d.ts +83 -0
- package/operations/payroll_item.js +26 -0
- package/operations/payroll_item_addition.d.ts +95 -0
- package/operations/payroll_item_addition.js +38 -0
- package/operations/payroll_item_company_contribution.d.ts +105 -0
- package/operations/payroll_item_company_contribution.js +38 -0
- package/operations/payroll_item_deduction.d.ts +101 -0
- package/operations/payroll_item_deduction.js +38 -0
- package/operations/payroll_item_direct_deposit.d.ts +65 -0
- package/operations/payroll_item_direct_deposit.js +38 -0
- package/operations/payroll_item_non_wage.d.ts +92 -0
- package/operations/payroll_item_non_wage.js +26 -0
- package/operations/payroll_item_tax.d.ts +108 -0
- package/operations/payroll_item_tax.js +38 -0
- package/operations/payroll_item_wage.d.ts +169 -0
- package/operations/payroll_item_wage.js +50 -0
- package/operations/payroll_item_workers_compensation.d.ts +77 -0
- package/operations/payroll_item_workers_compensation.js +38 -0
- package/operations/payroll_last_period.d.ts +31 -0
- package/operations/payroll_last_period.js +26 -0
- package/operations/payroll_liability_adjustment.d.ts +137 -0
- package/operations/payroll_liability_adjustment.js +38 -0
- package/operations/payroll_liability_check.d.ts +82 -0
- package/operations/payroll_liability_check.js +26 -0
- package/operations/payroll_prior_payment.d.ts +126 -0
- package/operations/payroll_prior_payment.js +38 -0
- package/operations/payroll_summary_report.d.ts +107 -0
- package/operations/payroll_summary_report.js +26 -0
- package/operations/payroll_year_to_date_adjustment.d.ts +156 -0
- package/operations/payroll_year_to_date_adjustment.js +38 -0
- package/operations/preferences.d.ts +64 -0
- package/operations/preferences.js +38 -0
- package/operations/price_level.d.ts +234 -0
- package/operations/price_level.js +50 -0
- package/operations/purchase_order.d.ts +620 -0
- package/operations/purchase_order.js +50 -0
- package/operations/qb_command_exec.d.ts +49 -0
- package/operations/qb_command_exec.js +26 -0
- package/operations/receive_payment.d.ts +450 -0
- package/operations/receive_payment.js +50 -0
- package/operations/receive_payment_to_deposit.d.ts +36 -0
- package/operations/receive_payment_to_deposit.js +26 -0
- package/operations/sales_order.d.ts +612 -0
- package/operations/sales_order.js +50 -0
- package/operations/sales_receipt.d.ts +650 -0
- package/operations/sales_receipt.js +50 -0
- package/operations/sales_rep.d.ts +170 -0
- package/operations/sales_rep.js +50 -0
- package/operations/sales_tax_code.d.ts +194 -0
- package/operations/sales_tax_code.js +50 -0
- package/operations/sales_tax_payable.d.ts +42 -0
- package/operations/sales_tax_payable.js +26 -0
- package/operations/sales_tax_payment_check.d.ts +254 -0
- package/operations/sales_tax_payment_check.js +50 -0
- package/operations/sales_tax_return.d.ts +35 -0
- package/operations/sales_tax_return.js +26 -0
- package/operations/sales_tax_return_line.d.ts +36 -0
- package/operations/sales_tax_return_line.js +26 -0
- package/operations/ship_method.d.ts +121 -0
- package/operations/ship_method.js +38 -0
- package/operations/special_account.d.ts +40 -0
- package/operations/special_account.js +26 -0
- package/operations/special_item.d.ts +44 -0
- package/operations/special_item.js +26 -0
- package/operations/standard_terms.d.ts +133 -0
- package/operations/standard_terms.js +38 -0
- package/operations/template.d.ts +36 -0
- package/operations/template.js +26 -0
- package/operations/terms.d.ts +90 -0
- package/operations/terms.js +26 -0
- package/operations/time_report.d.ts +84 -0
- package/operations/time_report.js +26 -0
- package/operations/time_tracking.d.ts +214 -0
- package/operations/time_tracking.js +50 -0
- package/operations/to_do.d.ts +254 -0
- package/operations/to_do.js +50 -0
- package/operations/transaction.d.ts +244 -0
- package/operations/transaction.js +26 -0
- package/operations/transfer.d.ts +178 -0
- package/operations/transfer.js +50 -0
- package/operations/transfer_inventory.d.ts +290 -0
- package/operations/transfer_inventory.js +50 -0
- package/operations/txn.d.ts +39 -0
- package/operations/txn.js +26 -0
- package/operations/txn_deleted.d.ts +44 -0
- package/operations/txn_deleted.js +26 -0
- package/operations/txn_display.d.ts +69 -0
- package/operations/txn_display.js +38 -0
- package/operations/txn_void.d.ts +39 -0
- package/operations/txn_void.js +26 -0
- package/operations/types.d.ts +1259 -0
- package/operations/unit_of_measure_set.d.ts +168 -0
- package/operations/unit_of_measure_set.js +38 -0
- package/operations/vehicle.d.ts +168 -0
- package/operations/vehicle.js +50 -0
- package/operations/vehicle_mileage.d.ts +147 -0
- package/operations/vehicle_mileage.js +38 -0
- package/operations/vendor.d.ts +541 -0
- package/operations/vendor.js +50 -0
- package/operations/vendor_credit.d.ts +365 -0
- package/operations/vendor_credit.js +50 -0
- package/operations/vendor_type.d.ts +127 -0
- package/operations/vendor_type.js +38 -0
- package/operations/workers_comp_code.d.ts +199 -0
- package/operations/workers_comp_code.js +50 -0
- package/package.json +14 -4
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks invoice operations. Types: invoice.d.ts. */
|
|
5
|
+
class Invoice {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create invoice.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./invoice").InvoiceCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/invoices/create-invoice
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("invoice.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List invoices (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./invoice").InvoiceQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/invoices/list-invoices
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("invoice.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update invoice.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./invoice").InvoiceUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/invoices/update-invoice
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("invoice.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { Invoice };
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, NameFilter, NameRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks item operations: `qube.item.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Item {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List items: `GET /connections/{connection_id}/items`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `iterator`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `owner_id`, `request_id`, `to_modified_date`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/items/list-items
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: ItemQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `item.query`: List items.
|
|
25
|
+
*/
|
|
26
|
+
export interface ItemQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
|
|
29
|
+
*
|
|
30
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
31
|
+
*/
|
|
32
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
33
|
+
/**
|
|
34
|
+
* 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.
|
|
35
|
+
*
|
|
36
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
37
|
+
*
|
|
38
|
+
* Format: date-time.
|
|
39
|
+
*/
|
|
40
|
+
from_modified_date?: string;
|
|
41
|
+
/**
|
|
42
|
+
* `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.
|
|
43
|
+
*
|
|
44
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
45
|
+
*/
|
|
46
|
+
full_name?: string[];
|
|
47
|
+
include_ret_element?: Array<"AccountRef" | "AcquiredAs" | "AssetAccountRef" | "AssetDesc" | "AssetNumber" | "AverageCost" | "BarCodeValue" | "BuildPoint" | "COGSAccountRef" | "ClassRef" | "CostBasis" | "DataExtRet" | "DepositToAccountRef" | "DiscountRate" | "DiscountRatePercent" | "EditSequence" | "ExternalGUID" | "FixedAssetSalesInfo" | "FullName" | "IncomeAccountRef" | "IsActive" | "IsPrintItemsInGroup" | "IsTaxIncluded" | "ItemDesc" | "ItemGroupLine" | "ItemInventoryAssemblyLine" | "ItemSalesTaxRef" | "ListID" | "Location" | "ManufacturerPartNumber" | "Max" | "Name" | "Notes" | "PONumber" | "ParentRef" | "PaymentMethodRef" | "PrefVendorRef" | "PurchaseCost" | "PurchaseDate" | "PurchaseDesc" | "PurchaseTaxCodeRef" | "QuantityOnHand" | "QuantityOnOrder" | "QuantityOnSalesOrder" | "ReorderPoint" | "SalesAndPurchase" | "SalesDesc" | "SalesOrPurchase" | "SalesPrice" | "SalesTaxCodeRef" | "SalesTaxReturnLineRef" | "SerialNumber" | "SpecialItemType" | "Sublevel" | "TaxRate" | "TaxVendorRef" | "TimeCreated" | "TimeModified" | "UnitOfMeasureSetRef" | "VendorOrPayeeName" | "WarrantyExpDate" | "YearEndAccumulatedDepreciation" | "YearEndBookValue">;
|
|
48
|
+
/**
|
|
49
|
+
* 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 `full_name` or `list_id` every match comes back in one answer, so leave `iterator` out.
|
|
50
|
+
*/
|
|
51
|
+
iterator?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* `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`.
|
|
54
|
+
*
|
|
55
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
56
|
+
*/
|
|
57
|
+
list_id?: string[];
|
|
58
|
+
/**
|
|
59
|
+
* 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.
|
|
60
|
+
*
|
|
61
|
+
* 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.
|
|
62
|
+
*
|
|
63
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
64
|
+
*
|
|
65
|
+
* Minimum 1.
|
|
66
|
+
*/
|
|
67
|
+
max_returned?: number;
|
|
68
|
+
/**
|
|
69
|
+
* 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.
|
|
70
|
+
*/
|
|
71
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
72
|
+
/**
|
|
73
|
+
* Filters according to the object’s Name.
|
|
74
|
+
*
|
|
75
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
76
|
+
*/
|
|
77
|
+
name_filter?: NameFilter;
|
|
78
|
+
/**
|
|
79
|
+
* Filters according to the object’s Name.
|
|
80
|
+
*
|
|
81
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
82
|
+
*/
|
|
83
|
+
name_range_filter?: NameRangeFilter;
|
|
84
|
+
/**
|
|
85
|
+
* `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.
|
|
86
|
+
*/
|
|
87
|
+
owner_id?: string[];
|
|
88
|
+
/**
|
|
89
|
+
* 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`.
|
|
90
|
+
*/
|
|
91
|
+
request_id?: string;
|
|
92
|
+
/**
|
|
93
|
+
* 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).
|
|
94
|
+
*
|
|
95
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
96
|
+
*
|
|
97
|
+
* Format: date-time.
|
|
98
|
+
*/
|
|
99
|
+
to_modified_date?: string;
|
|
100
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks item operations. Types: item.d.ts. */
|
|
5
|
+
class Item {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List items (answers in pages, one webhook each).
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./item").ItemQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/items/list-items
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("item.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { Item };
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, CurrencyRef } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks item assemblies can build operations: `qube.itemAssembliesCanBuild.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ItemAssembliesCanBuild {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List item assemblies can builds: `GET /connections/{connection_id}/item-assemblies-can-builds`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `item_inventory_assembly_ref` (required), `request_id`, `txn_date` (required).
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-assemblies-can-builds/list-item-assemblies-can-builds
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: ItemAssembliesCanBuildQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `item_assemblies_can_build.query`: List item assemblies can builds.
|
|
25
|
+
*/
|
|
26
|
+
export interface ItemAssembliesCanBuildQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* 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.
|
|
29
|
+
*/
|
|
30
|
+
item_inventory_assembly_ref: CurrencyRef;
|
|
31
|
+
/**
|
|
32
|
+
* 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`.
|
|
33
|
+
*/
|
|
34
|
+
request_id?: string;
|
|
35
|
+
/**
|
|
36
|
+
* 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.
|
|
37
|
+
*
|
|
38
|
+
* Format: date.
|
|
39
|
+
*/
|
|
40
|
+
txn_date: string;
|
|
41
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks item assemblies can build operations. Types: item_assemblies_can_build.d.ts. */
|
|
5
|
+
class ItemAssembliesCanBuild {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List item assemblies can builds.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./item_assemblies_can_build").ItemAssembliesCanBuildQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-assemblies-can-builds/list-item-assemblies-can-builds
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("item_assemblies_can_build.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { ItemAssembliesCanBuild };
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AccountFilter, BarCodeItemDiscount, CurrencyRef, NameFilter, NameRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks item discount operations: `qube.itemDiscount.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ItemDiscount {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create item discount: `POST /connections/{connection_id}/item-discounts`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `account_ref`, `bar_code`, `class_ref`, `discount_rate`, `discount_rate_percent`, `external_guid`, `include_ret_element`, `is_active`, `item_desc`, `name` (required), `parent_ref`, `request_id`, `sales_tax_code_ref`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-discounts/create-item-discount
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ItemDiscountCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List item discounts: `GET /connections/{connection_id}/item-discounts`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `active_status`, `class_filter`, `from_modified_date`, `full_name`, `include_ret_element`, `iterator`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `owner_id`, `request_id`, `to_modified_date`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-discounts/list-item-discounts
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: ItemDiscountQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update item discount: `PUT /connections/{connection_id}/item-discounts`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `account_ref`, `apply_account_ref_to_existing_txns`, `bar_code`, `class_ref`, `discount_rate`, `discount_rate_percent`, `edit_sequence` (required), `include_ret_element`, `is_active`, `item_desc`, `list_id` (required), `name`, `parent_ref`, `request_id`, `sales_tax_code_ref`.
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-discounts/update-item-discount
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: ItemDiscountUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `item_discount.create`: Create item discount.
|
|
49
|
+
*/
|
|
50
|
+
export interface ItemDiscountCreateParams {
|
|
51
|
+
/**
|
|
52
|
+
* `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
|
|
53
|
+
*/
|
|
54
|
+
account_ref?: CurrencyRef;
|
|
55
|
+
/**
|
|
56
|
+
* Barcode reference information.
|
|
57
|
+
*/
|
|
58
|
+
bar_code?: BarCodeItemDiscount;
|
|
59
|
+
/**
|
|
60
|
+
* Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
|
|
61
|
+
*/
|
|
62
|
+
class_ref?: CurrencyRef;
|
|
63
|
+
/**
|
|
64
|
+
* The discount rate when it is given as a monetary amount. `discount_rate` will be subtracted from a total or subtotal.
|
|
65
|
+
*
|
|
66
|
+
* Choose at most one of: `discount_rate`, or `discount_rate_percent`.
|
|
67
|
+
*/
|
|
68
|
+
discount_rate?: number;
|
|
69
|
+
/**
|
|
70
|
+
* The discount rate when it is given as a percent. `discount_rate_percent` will be subtracted from a total or subtotal.
|
|
71
|
+
*
|
|
72
|
+
* Choose at most one of: `discount_rate`, or `discount_rate_percent`.
|
|
73
|
+
*/
|
|
74
|
+
discount_rate_percent?: number;
|
|
75
|
+
/**
|
|
76
|
+
* Allows for the attachment of a user defined GUID value.
|
|
77
|
+
*/
|
|
78
|
+
external_guid?: string;
|
|
79
|
+
include_ret_element?: Array<"AccountRef" | "BarCodeValue" | "ClassRef" | "DataExtRet" | "DiscountRate" | "DiscountRatePercent" | "EditSequence" | "ExternalGUID" | "FullName" | "IsActive" | "ItemDesc" | "ListID" | "Name" | "OwnerID" | "ParentRef" | "SalesTaxCodeRef" | "Sublevel" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
80
|
+
/**
|
|
81
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
82
|
+
*/
|
|
83
|
+
is_active?: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* The description that will appear on a sales form when the item is used.
|
|
86
|
+
*/
|
|
87
|
+
item_desc?: string;
|
|
88
|
+
/**
|
|
89
|
+
* 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.
|
|
90
|
+
*/
|
|
91
|
+
name: string;
|
|
92
|
+
/**
|
|
93
|
+
* A reference to the list object that is one level above this one. For example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request, if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
94
|
+
*/
|
|
95
|
+
parent_ref?: CurrencyRef;
|
|
96
|
+
/**
|
|
97
|
+
* 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`.
|
|
98
|
+
*/
|
|
99
|
+
request_id?: string;
|
|
100
|
+
/**
|
|
101
|
+
* `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
|
|
102
|
+
*/
|
|
103
|
+
sales_tax_code_ref?: CurrencyRef;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* The params of `item_discount.query`: List item discounts.
|
|
108
|
+
*/
|
|
109
|
+
export interface ItemDiscountQueryParams {
|
|
110
|
+
/**
|
|
111
|
+
* Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
|
|
112
|
+
*
|
|
113
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
114
|
+
*/
|
|
115
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
116
|
+
/**
|
|
117
|
+
* Filters according to the object’s class.
|
|
118
|
+
*
|
|
119
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
120
|
+
*/
|
|
121
|
+
class_filter?: AccountFilter;
|
|
122
|
+
/**
|
|
123
|
+
* 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.
|
|
124
|
+
*
|
|
125
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
126
|
+
*
|
|
127
|
+
* Format: date-time.
|
|
128
|
+
*/
|
|
129
|
+
from_modified_date?: string;
|
|
130
|
+
/**
|
|
131
|
+
* `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.
|
|
132
|
+
*
|
|
133
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
134
|
+
*/
|
|
135
|
+
full_name?: string[];
|
|
136
|
+
include_ret_element?: Array<"AccountRef" | "BarCodeValue" | "ClassRef" | "DataExtRet" | "DiscountRate" | "DiscountRatePercent" | "EditSequence" | "ExternalGUID" | "FullName" | "IsActive" | "ItemDesc" | "ListID" | "Name" | "ParentRef" | "SalesTaxCodeRef" | "Sublevel" | "TimeCreated" | "TimeModified">;
|
|
137
|
+
/**
|
|
138
|
+
* 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 `full_name` or `list_id` every match comes back in one answer, so leave `iterator` out.
|
|
139
|
+
*/
|
|
140
|
+
iterator?: boolean;
|
|
141
|
+
/**
|
|
142
|
+
* `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`.
|
|
143
|
+
*
|
|
144
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
145
|
+
*/
|
|
146
|
+
list_id?: string[];
|
|
147
|
+
/**
|
|
148
|
+
* 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.
|
|
149
|
+
*
|
|
150
|
+
* 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.
|
|
151
|
+
*
|
|
152
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
153
|
+
*
|
|
154
|
+
* Minimum 1.
|
|
155
|
+
*/
|
|
156
|
+
max_returned?: number;
|
|
157
|
+
/**
|
|
158
|
+
* 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.
|
|
159
|
+
*/
|
|
160
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
161
|
+
/**
|
|
162
|
+
* Filters according to the object’s Name.
|
|
163
|
+
*
|
|
164
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
165
|
+
*/
|
|
166
|
+
name_filter?: NameFilter;
|
|
167
|
+
/**
|
|
168
|
+
* Filters according to the object’s Name.
|
|
169
|
+
*
|
|
170
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
171
|
+
*/
|
|
172
|
+
name_range_filter?: NameRangeFilter;
|
|
173
|
+
/**
|
|
174
|
+
* `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.
|
|
175
|
+
*/
|
|
176
|
+
owner_id?: string[];
|
|
177
|
+
/**
|
|
178
|
+
* 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`.
|
|
179
|
+
*/
|
|
180
|
+
request_id?: string;
|
|
181
|
+
/**
|
|
182
|
+
* 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).
|
|
183
|
+
*
|
|
184
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
185
|
+
*
|
|
186
|
+
* Format: date-time.
|
|
187
|
+
*/
|
|
188
|
+
to_modified_date?: string;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* The params of `item_discount.update`: Update item discount.
|
|
193
|
+
*/
|
|
194
|
+
export interface ItemDiscountUpdateParams {
|
|
195
|
+
/**
|
|
196
|
+
* `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
|
|
197
|
+
*/
|
|
198
|
+
account_ref?: CurrencyRef;
|
|
199
|
+
/**
|
|
200
|
+
* Used to support changing the `account_ref` in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not. Specifying False basically dismisses this with a “No” answer; specifying True dismisses it with a “Yes” answer and then changes the existing transactions that use the item with that `account_ref`.
|
|
201
|
+
*/
|
|
202
|
+
apply_account_ref_to_existing_txns?: boolean;
|
|
203
|
+
/**
|
|
204
|
+
* Barcode reference information.
|
|
205
|
+
*/
|
|
206
|
+
bar_code?: BarCodeItemDiscount;
|
|
207
|
+
/**
|
|
208
|
+
* Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
|
|
209
|
+
*/
|
|
210
|
+
class_ref?: CurrencyRef;
|
|
211
|
+
/**
|
|
212
|
+
* The discount rate when it is given as a monetary amount. `discount_rate` will be subtracted from a total or subtotal.
|
|
213
|
+
*
|
|
214
|
+
* Choose at most one of: `discount_rate`, or `discount_rate_percent`.
|
|
215
|
+
*/
|
|
216
|
+
discount_rate?: number;
|
|
217
|
+
/**
|
|
218
|
+
* The discount rate when it is given as a percent. `discount_rate_percent` will be subtracted from a total or subtotal.
|
|
219
|
+
*
|
|
220
|
+
* Choose at most one of: `discount_rate`, or `discount_rate_percent`.
|
|
221
|
+
*/
|
|
222
|
+
discount_rate_percent?: number;
|
|
223
|
+
/**
|
|
224
|
+
* `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.
|
|
225
|
+
*/
|
|
226
|
+
edit_sequence: string;
|
|
227
|
+
include_ret_element?: Array<"AccountRef" | "BarCodeValue" | "ClassRef" | "DataExtRet" | "DiscountRate" | "DiscountRatePercent" | "EditSequence" | "ExternalGUID" | "FullName" | "IsActive" | "ItemDesc" | "ListID" | "Name" | "OwnerID" | "ParentRef" | "SalesTaxCodeRef" | "Sublevel" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
228
|
+
/**
|
|
229
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
230
|
+
*/
|
|
231
|
+
is_active?: boolean;
|
|
232
|
+
/**
|
|
233
|
+
* The description that will appear on a sales form when the item is used.
|
|
234
|
+
*/
|
|
235
|
+
item_desc?: string;
|
|
236
|
+
/**
|
|
237
|
+
* `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`.
|
|
238
|
+
*/
|
|
239
|
+
list_id: string;
|
|
240
|
+
/**
|
|
241
|
+
* 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.
|
|
242
|
+
*/
|
|
243
|
+
name?: string;
|
|
244
|
+
/**
|
|
245
|
+
* A reference to the list object that is one level above this one. For example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request, if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
246
|
+
*/
|
|
247
|
+
parent_ref?: CurrencyRef;
|
|
248
|
+
/**
|
|
249
|
+
* 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`.
|
|
250
|
+
*/
|
|
251
|
+
request_id?: string;
|
|
252
|
+
/**
|
|
253
|
+
* `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
|
|
254
|
+
*/
|
|
255
|
+
sales_tax_code_ref?: CurrencyRef;
|
|
256
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks item discount operations. Types: item_discount.d.ts. */
|
|
5
|
+
class ItemDiscount {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create item discount.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./item_discount").ItemDiscountCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-discounts/create-item-discount
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("item_discount.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List item discounts (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./item_discount").ItemDiscountQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-discounts/list-item-discounts
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("item_discount.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update item discount.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./item_discount").ItemDiscountUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-discounts/update-item-discount
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("item_discount.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { ItemDiscount };
|