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 item receipt operations. Types: item_receipt.d.ts. */
|
|
5
|
+
class ItemReceipt {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create item receipt.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./item_receipt").ItemReceiptCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-receipts/create-item-receipt
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("item_receipt.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List item receipts (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./item_receipt").ItemReceiptQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-receipts/list-item-receipts
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("item_receipt.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update item receipt.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./item_receipt").ItemReceiptUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-receipts/update-item-receipt
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("item_receipt.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { ItemReceipt };
|
|
@@ -0,0 +1,228 @@
|
|
|
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 sales tax operations: `qube.itemSalesTax.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ItemSalesTax {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create item sales tax: `POST /connections/{connection_id}/item-sales-taxes`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `bar_code`, `class_ref`, `external_guid`, `include_ret_element`, `is_active`, `item_desc`, `name` (required), `request_id`, `sales_tax_return_line_ref`, `tax_rate`, `tax_vendor_ref`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-taxes/create-item-sales-tax
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ItemSalesTaxCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List item sales taxes: `GET /connections/{connection_id}/item-sales-taxes`, 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-sales-taxes/list-item-sales-taxes
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: ItemSalesTaxQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update item sales tax: `PUT /connections/{connection_id}/item-sales-taxes`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `bar_code`, `class_ref`, `edit_sequence` (required), `include_ret_element`, `is_active`, `item_desc`, `list_id` (required), `name`, `request_id`, `sales_tax_return_line_ref`, `tax_rate`, `tax_vendor_ref`.
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-taxes/update-item-sales-tax
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: ItemSalesTaxUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `item_sales_tax.create`: Create item sales tax.
|
|
49
|
+
*/
|
|
50
|
+
export interface ItemSalesTaxCreateParams {
|
|
51
|
+
/**
|
|
52
|
+
* Barcode reference information.
|
|
53
|
+
*/
|
|
54
|
+
bar_code?: BarCodeItemDiscount;
|
|
55
|
+
/**
|
|
56
|
+
* 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.
|
|
57
|
+
*/
|
|
58
|
+
class_ref?: CurrencyRef;
|
|
59
|
+
/**
|
|
60
|
+
* Allows for the attachment of a user defined GUID value.
|
|
61
|
+
*/
|
|
62
|
+
external_guid?: string;
|
|
63
|
+
include_ret_element?: Array<"BarCodeValue" | "ClassRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsActive" | "ItemDesc" | "ListID" | "Name" | "OwnerID" | "SalesTaxReturnLineRef" | "TaxRate" | "TaxVendorRef" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
64
|
+
/**
|
|
65
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
66
|
+
*/
|
|
67
|
+
is_active?: boolean;
|
|
68
|
+
/**
|
|
69
|
+
* The description that will appear on a sales form when the item is used.
|
|
70
|
+
*/
|
|
71
|
+
item_desc?: string;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
*/
|
|
75
|
+
name: string;
|
|
76
|
+
/**
|
|
77
|
+
* 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`.
|
|
78
|
+
*/
|
|
79
|
+
request_id?: string;
|
|
80
|
+
/**
|
|
81
|
+
* Sales tax return line information.
|
|
82
|
+
*/
|
|
83
|
+
sales_tax_return_line_ref?: CurrencyRef;
|
|
84
|
+
/**
|
|
85
|
+
* The tax rate. If a nonzero `tax_rate` is specified, then `tax_vendor_ref` is required.
|
|
86
|
+
*/
|
|
87
|
+
tax_rate?: number;
|
|
88
|
+
/**
|
|
89
|
+
* Refers to the tax agency to whom collected taxes are owed. (This will be a vendor on the Vendor list.) If a nonzero `tax_rate` is specified, then `tax_vendor_ref` is required. In a request, if a `tax_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
90
|
+
*/
|
|
91
|
+
tax_vendor_ref?: CurrencyRef;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* The params of `item_sales_tax.query`: List item sales taxes.
|
|
96
|
+
*/
|
|
97
|
+
export interface ItemSalesTaxQueryParams {
|
|
98
|
+
/**
|
|
99
|
+
* 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.
|
|
100
|
+
*
|
|
101
|
+
* 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.
|
|
102
|
+
*/
|
|
103
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
104
|
+
/**
|
|
105
|
+
* Filters according to the object’s class.
|
|
106
|
+
*
|
|
107
|
+
* 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.
|
|
108
|
+
*/
|
|
109
|
+
class_filter?: AccountFilter;
|
|
110
|
+
/**
|
|
111
|
+
* 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.
|
|
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
|
+
* Format: date-time.
|
|
116
|
+
*/
|
|
117
|
+
from_modified_date?: string;
|
|
118
|
+
/**
|
|
119
|
+
* `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.
|
|
120
|
+
*
|
|
121
|
+
* 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.
|
|
122
|
+
*/
|
|
123
|
+
full_name?: string[];
|
|
124
|
+
include_ret_element?: Array<"BarCodeValue" | "ClassRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsActive" | "ItemDesc" | "ListID" | "Name" | "SalesTaxReturnLineRef" | "TaxRate" | "TaxVendorRef" | "TimeCreated" | "TimeModified">;
|
|
125
|
+
/**
|
|
126
|
+
* 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.
|
|
127
|
+
*/
|
|
128
|
+
iterator?: boolean;
|
|
129
|
+
/**
|
|
130
|
+
* `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`.
|
|
131
|
+
*
|
|
132
|
+
* 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.
|
|
133
|
+
*/
|
|
134
|
+
list_id?: string[];
|
|
135
|
+
/**
|
|
136
|
+
* 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.
|
|
137
|
+
*
|
|
138
|
+
* 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.
|
|
139
|
+
*
|
|
140
|
+
* 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.
|
|
141
|
+
*
|
|
142
|
+
* Minimum 1.
|
|
143
|
+
*/
|
|
144
|
+
max_returned?: number;
|
|
145
|
+
/**
|
|
146
|
+
* 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.
|
|
147
|
+
*/
|
|
148
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
149
|
+
/**
|
|
150
|
+
* Filters according to the object’s Name.
|
|
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
|
+
name_filter?: NameFilter;
|
|
155
|
+
/**
|
|
156
|
+
* Filters according to the object’s Name.
|
|
157
|
+
*
|
|
158
|
+
* 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.
|
|
159
|
+
*/
|
|
160
|
+
name_range_filter?: NameRangeFilter;
|
|
161
|
+
/**
|
|
162
|
+
* `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.
|
|
163
|
+
*/
|
|
164
|
+
owner_id?: string[];
|
|
165
|
+
/**
|
|
166
|
+
* 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`.
|
|
167
|
+
*/
|
|
168
|
+
request_id?: string;
|
|
169
|
+
/**
|
|
170
|
+
* 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).
|
|
171
|
+
*
|
|
172
|
+
* 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.
|
|
173
|
+
*
|
|
174
|
+
* Format: date-time.
|
|
175
|
+
*/
|
|
176
|
+
to_modified_date?: string;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* The params of `item_sales_tax.update`: Update item sales tax.
|
|
181
|
+
*/
|
|
182
|
+
export interface ItemSalesTaxUpdateParams {
|
|
183
|
+
/**
|
|
184
|
+
* Barcode reference information.
|
|
185
|
+
*/
|
|
186
|
+
bar_code?: BarCodeItemDiscount;
|
|
187
|
+
/**
|
|
188
|
+
* 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.
|
|
189
|
+
*/
|
|
190
|
+
class_ref?: CurrencyRef;
|
|
191
|
+
/**
|
|
192
|
+
* `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.
|
|
193
|
+
*/
|
|
194
|
+
edit_sequence: string;
|
|
195
|
+
include_ret_element?: Array<"BarCodeValue" | "ClassRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsActive" | "ItemDesc" | "ListID" | "Name" | "OwnerID" | "SalesTaxReturnLineRef" | "TaxRate" | "TaxVendorRef" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
196
|
+
/**
|
|
197
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
198
|
+
*/
|
|
199
|
+
is_active?: boolean;
|
|
200
|
+
/**
|
|
201
|
+
* The description that will appear on a sales form when the item is used.
|
|
202
|
+
*/
|
|
203
|
+
item_desc?: string;
|
|
204
|
+
/**
|
|
205
|
+
* `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`.
|
|
206
|
+
*/
|
|
207
|
+
list_id: string;
|
|
208
|
+
/**
|
|
209
|
+
* 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.
|
|
210
|
+
*/
|
|
211
|
+
name?: string;
|
|
212
|
+
/**
|
|
213
|
+
* 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`.
|
|
214
|
+
*/
|
|
215
|
+
request_id?: string;
|
|
216
|
+
/**
|
|
217
|
+
* Sales tax return line information.
|
|
218
|
+
*/
|
|
219
|
+
sales_tax_return_line_ref?: CurrencyRef;
|
|
220
|
+
/**
|
|
221
|
+
* The tax rate. If a nonzero `tax_rate` is specified, then `tax_vendor_ref` is required.
|
|
222
|
+
*/
|
|
223
|
+
tax_rate?: number;
|
|
224
|
+
/**
|
|
225
|
+
* Refers to the tax agency to whom collected taxes are owed. (This will be a vendor on the Vendor list.) If a nonzero `tax_rate` is specified, then `tax_vendor_ref` is required. In a request, if a `tax_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
226
|
+
*/
|
|
227
|
+
tax_vendor_ref?: CurrencyRef;
|
|
228
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks item sales tax operations. Types: item_sales_tax.d.ts. */
|
|
5
|
+
class ItemSalesTax {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create item sales tax.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./item_sales_tax").ItemSalesTaxCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-taxes/create-item-sales-tax
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("item_sales_tax.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List item sales taxes (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./item_sales_tax").ItemSalesTaxQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-taxes/list-item-sales-taxes
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("item_sales_tax.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update item sales tax.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./item_sales_tax").ItemSalesTaxUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-taxes/update-item-sales-tax
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("item_sales_tax.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { ItemSalesTax };
|
|
@@ -0,0 +1,192 @@
|
|
|
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, BarCodeItemDiscount, CurrencyRef, NameFilter, NameRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks item sales tax group operations: `qube.itemSalesTaxGroup.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ItemSalesTaxGroup {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create item sales tax group: `POST /connections/{connection_id}/item-sales-tax-groups`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `bar_code`, `external_guid`, `include_ret_element`, `is_active`, `item_desc`, `item_sales_tax_ref` (required), `name` (required), `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-tax-groups/create-item-sales-tax-group
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ItemSalesTaxGroupCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List item sales tax groups: `GET /connections/{connection_id}/item-sales-tax-groups`, 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`, `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-sales-tax-groups/list-item-sales-tax-groups
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: ItemSalesTaxGroupQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update item sales tax group: `PUT /connections/{connection_id}/item-sales-tax-groups`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `bar_code`, `edit_sequence` (required), `include_ret_element`, `is_active`, `item_desc`, `item_sales_tax_ref`, `list_id` (required), `name`, `request_id`.
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-tax-groups/update-item-sales-tax-group
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: ItemSalesTaxGroupUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `item_sales_tax_group.create`: Create item sales tax group.
|
|
49
|
+
*/
|
|
50
|
+
export interface ItemSalesTaxGroupCreateParams {
|
|
51
|
+
/**
|
|
52
|
+
* Barcode reference information.
|
|
53
|
+
*/
|
|
54
|
+
bar_code?: BarCodeItemDiscount;
|
|
55
|
+
/**
|
|
56
|
+
* Allows for the attachment of a user defined GUID value.
|
|
57
|
+
*/
|
|
58
|
+
external_guid?: string;
|
|
59
|
+
include_ret_element?: Array<"BarCodeValue" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsActive" | "ItemDesc" | "ItemSalesTaxRef" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
60
|
+
/**
|
|
61
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
62
|
+
*/
|
|
63
|
+
is_active?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* The description that will appear on a sales form when the item is used.
|
|
66
|
+
*/
|
|
67
|
+
item_desc?: string;
|
|
68
|
+
item_sales_tax_ref: CurrencyRef[];
|
|
69
|
+
/**
|
|
70
|
+
* 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.
|
|
71
|
+
*/
|
|
72
|
+
name: string;
|
|
73
|
+
/**
|
|
74
|
+
* 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`.
|
|
75
|
+
*/
|
|
76
|
+
request_id?: string;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* The params of `item_sales_tax_group.query`: List item sales tax groups.
|
|
81
|
+
*/
|
|
82
|
+
export interface ItemSalesTaxGroupQueryParams {
|
|
83
|
+
/**
|
|
84
|
+
* 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.
|
|
85
|
+
*
|
|
86
|
+
* 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.
|
|
87
|
+
*/
|
|
88
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
89
|
+
/**
|
|
90
|
+
* 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.
|
|
91
|
+
*
|
|
92
|
+
* 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.
|
|
93
|
+
*
|
|
94
|
+
* Format: date-time.
|
|
95
|
+
*/
|
|
96
|
+
from_modified_date?: string;
|
|
97
|
+
/**
|
|
98
|
+
* `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.
|
|
99
|
+
*
|
|
100
|
+
* 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.
|
|
101
|
+
*/
|
|
102
|
+
full_name?: string[];
|
|
103
|
+
include_ret_element?: Array<"BarCodeValue" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsActive" | "ItemDesc" | "ItemSalesTaxRef" | "ListID" | "Name" | "TimeCreated" | "TimeModified">;
|
|
104
|
+
/**
|
|
105
|
+
* 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.
|
|
106
|
+
*/
|
|
107
|
+
iterator?: boolean;
|
|
108
|
+
/**
|
|
109
|
+
* `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`.
|
|
110
|
+
*
|
|
111
|
+
* 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.
|
|
112
|
+
*/
|
|
113
|
+
list_id?: string[];
|
|
114
|
+
/**
|
|
115
|
+
* 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.
|
|
116
|
+
*
|
|
117
|
+
* 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.
|
|
118
|
+
*
|
|
119
|
+
* 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.
|
|
120
|
+
*
|
|
121
|
+
* Minimum 1.
|
|
122
|
+
*/
|
|
123
|
+
max_returned?: number;
|
|
124
|
+
/**
|
|
125
|
+
* 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.
|
|
126
|
+
*/
|
|
127
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
128
|
+
/**
|
|
129
|
+
* Filters according to the object’s Name.
|
|
130
|
+
*
|
|
131
|
+
* 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.
|
|
132
|
+
*/
|
|
133
|
+
name_filter?: NameFilter;
|
|
134
|
+
/**
|
|
135
|
+
* Filters according to the object’s Name.
|
|
136
|
+
*
|
|
137
|
+
* 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.
|
|
138
|
+
*/
|
|
139
|
+
name_range_filter?: NameRangeFilter;
|
|
140
|
+
/**
|
|
141
|
+
* `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.
|
|
142
|
+
*/
|
|
143
|
+
owner_id?: string[];
|
|
144
|
+
/**
|
|
145
|
+
* 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`.
|
|
146
|
+
*/
|
|
147
|
+
request_id?: string;
|
|
148
|
+
/**
|
|
149
|
+
* 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).
|
|
150
|
+
*
|
|
151
|
+
* 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.
|
|
152
|
+
*
|
|
153
|
+
* Format: date-time.
|
|
154
|
+
*/
|
|
155
|
+
to_modified_date?: string;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* The params of `item_sales_tax_group.update`: Update item sales tax group.
|
|
160
|
+
*/
|
|
161
|
+
export interface ItemSalesTaxGroupUpdateParams {
|
|
162
|
+
/**
|
|
163
|
+
* Barcode reference information.
|
|
164
|
+
*/
|
|
165
|
+
bar_code?: BarCodeItemDiscount;
|
|
166
|
+
/**
|
|
167
|
+
* `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.
|
|
168
|
+
*/
|
|
169
|
+
edit_sequence: string;
|
|
170
|
+
include_ret_element?: Array<"BarCodeValue" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsActive" | "ItemDesc" | "ItemSalesTaxRef" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
171
|
+
/**
|
|
172
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
173
|
+
*/
|
|
174
|
+
is_active?: boolean;
|
|
175
|
+
/**
|
|
176
|
+
* The description that will appear on a sales form when the item is used.
|
|
177
|
+
*/
|
|
178
|
+
item_desc?: string;
|
|
179
|
+
item_sales_tax_ref?: CurrencyRef[];
|
|
180
|
+
/**
|
|
181
|
+
* `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`.
|
|
182
|
+
*/
|
|
183
|
+
list_id: string;
|
|
184
|
+
/**
|
|
185
|
+
* 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.
|
|
186
|
+
*/
|
|
187
|
+
name?: string;
|
|
188
|
+
/**
|
|
189
|
+
* 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`.
|
|
190
|
+
*/
|
|
191
|
+
request_id?: string;
|
|
192
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks item sales tax group operations. Types: item_sales_tax_group.d.ts. */
|
|
5
|
+
class ItemSalesTaxGroup {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create item sales tax group.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./item_sales_tax_group").ItemSalesTaxGroupCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-tax-groups/create-item-sales-tax-group
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("item_sales_tax_group.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List item sales tax groups (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./item_sales_tax_group").ItemSalesTaxGroupQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-tax-groups/list-item-sales-tax-groups
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("item_sales_tax_group.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update item sales tax group.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./item_sales_tax_group").ItemSalesTaxGroupUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/item-sales-tax-groups/update-item-sales-tax-group
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("item_sales_tax_group.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { ItemSalesTaxGroup };
|