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 build assembly operations. Types: build_assembly.d.ts. */
|
|
5
|
+
class BuildAssembly {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create build assembly.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./build_assembly").BuildAssemblyCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/build-assemblies/create-build-assembly
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("build_assembly.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List build assemblies (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./build_assembly").BuildAssemblyQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/build-assemblies/list-build-assemblies
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("build_assembly.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update build assembly.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./build_assembly").BuildAssemblyUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/build-assemblies/update-build-assembly
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("build_assembly.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { BuildAssembly };
|
|
@@ -0,0 +1,330 @@
|
|
|
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, CurrencyRef, ModifiedDateRangeFilter, RefNumberFilter, RefNumberRangeFilter, TxnDateRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks charge operations: `qube.charge.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Charge {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create charge: `POST /connections/{connection_id}/charges`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `amount`, `ar_account_ref`, `billed_date`, `class_ref`, `customer_ref` (required), `def_macro`, `desc`, `due_date`, `external_guid`, `include_ret_element`, `inventory_site_location_ref`, `inventory_site_ref`, `item_ref`, `option_for_price_rule_conflict`, `override_item_account_ref`, `quantity`, `rate`, `ref_number`, `request_id`, `txn_date`, `unit_of_measure`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/charges/create-charge
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ChargeCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List charges: `GET /connections/{connection_id}/charges`, 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: `account_filter`, `entity_filter`, `include_linked_txns`, `include_ret_element`, `iterator`, `max_returned`, `meta_data`, `modified_date_range_filter`, `owner_id`, `paid_status`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/charges/list-charges
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: ChargeQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update charge: `PUT /connections/{connection_id}/charges`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `amount`, `ar_account_ref`, `billed_date`, `class_ref`, `customer_ref`, `desc`, `due_date`, `edit_sequence` (required), `include_ret_element`, `inventory_site_location_ref`, `inventory_site_ref`, `item_ref`, `option_for_price_rule_conflict`, `override_item_account_ref`, `override_uom_set_ref`, `quantity`, `rate`, `ref_number`, `request_id`, `txn_date`, `txn_id` (required), `unit_of_measure`.
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/charges/update-charge
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: ChargeUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `charge.create`: Create charge.
|
|
49
|
+
*/
|
|
50
|
+
export interface ChargeCreateParams {
|
|
51
|
+
/**
|
|
52
|
+
* A monetary amount.
|
|
53
|
+
*/
|
|
54
|
+
amount?: number;
|
|
55
|
+
/**
|
|
56
|
+
* `ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
57
|
+
*/
|
|
58
|
+
ar_account_ref?: CurrencyRef;
|
|
59
|
+
/**
|
|
60
|
+
* The date when the customer was billed for what is now being charged to their credit card. (`billed_date` is the same as the date listed on an invoice or, for a statement charge, the date entered in the Statement Date field when the statement was printed.)
|
|
61
|
+
*
|
|
62
|
+
* Format: date.
|
|
63
|
+
*/
|
|
64
|
+
billed_date?: string;
|
|
65
|
+
/**
|
|
66
|
+
* 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.
|
|
67
|
+
*/
|
|
68
|
+
class_ref?: CurrencyRef;
|
|
69
|
+
/**
|
|
70
|
+
* `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
|
|
71
|
+
*/
|
|
72
|
+
customer_ref: CurrencyRef;
|
|
73
|
+
/**
|
|
74
|
+
* `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
|
|
75
|
+
*/
|
|
76
|
+
def_macro?: string;
|
|
77
|
+
/**
|
|
78
|
+
* A descriptive text field.
|
|
79
|
+
*/
|
|
80
|
+
desc?: string;
|
|
81
|
+
/**
|
|
82
|
+
* The date on which payment is due.
|
|
83
|
+
*
|
|
84
|
+
* Format: date.
|
|
85
|
+
*/
|
|
86
|
+
due_date?: string;
|
|
87
|
+
/**
|
|
88
|
+
* Allows for the attachment of a user defined GUID value.
|
|
89
|
+
*/
|
|
90
|
+
external_guid?: string;
|
|
91
|
+
include_ret_element?: Array<"ARAccountRef" | "Amount" | "BalanceRemaining" | "BilledDate" | "ClassRef" | "CustomerRef" | "DataExtRet" | "Desc" | "DueDate" | "EditSequence" | "ExternalGUID" | "InventorySiteLocationRef" | "InventorySiteRef" | "IsPaid" | "ItemRef" | "LinkedTxn" | "ListID" | "OverrideUOMSetRef" | "OwnerID" | "Quantity" | "Rate" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber" | "UnitOfMeasure">;
|
|
92
|
+
/**
|
|
93
|
+
* Location within the Inventory Site
|
|
94
|
+
*/
|
|
95
|
+
inventory_site_location_ref?: CurrencyRef;
|
|
96
|
+
/**
|
|
97
|
+
* Site where inventory is located.
|
|
98
|
+
*/
|
|
99
|
+
inventory_site_ref?: CurrencyRef;
|
|
100
|
+
/**
|
|
101
|
+
* `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
102
|
+
*/
|
|
103
|
+
item_ref?: CurrencyRef;
|
|
104
|
+
/**
|
|
105
|
+
* Flag to override price rule conflict.
|
|
106
|
+
*/
|
|
107
|
+
option_for_price_rule_conflict?: "BasePrice" | "Zero";
|
|
108
|
+
/**
|
|
109
|
+
* Refers to a QuickBooks account. If an `override_item_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
110
|
+
*/
|
|
111
|
+
override_item_account_ref?: CurrencyRef;
|
|
112
|
+
/**
|
|
113
|
+
* On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
|
|
114
|
+
*/
|
|
115
|
+
quantity?: number;
|
|
116
|
+
/**
|
|
117
|
+
* Indicates the price of something.
|
|
118
|
+
*/
|
|
119
|
+
rate?: number;
|
|
120
|
+
/**
|
|
121
|
+
* `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
|
|
122
|
+
*/
|
|
123
|
+
ref_number?: string;
|
|
124
|
+
/**
|
|
125
|
+
* 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`.
|
|
126
|
+
*/
|
|
127
|
+
request_id?: string;
|
|
128
|
+
/**
|
|
129
|
+
* 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.
|
|
130
|
+
*
|
|
131
|
+
* Format: date.
|
|
132
|
+
*/
|
|
133
|
+
txn_date?: string;
|
|
134
|
+
/**
|
|
135
|
+
* In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
|
|
136
|
+
*/
|
|
137
|
+
unit_of_measure?: string;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* The params of `charge.query`: List charges.
|
|
142
|
+
*/
|
|
143
|
+
export interface ChargeQueryParams {
|
|
144
|
+
/**
|
|
145
|
+
* Filters according to the account name or `list_id`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `full_name` and get the account you’re looking for. But if numbers have been used as account names, confusion could arise.
|
|
146
|
+
*
|
|
147
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
148
|
+
*/
|
|
149
|
+
account_filter?: AccountFilter;
|
|
150
|
+
/**
|
|
151
|
+
* An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an EntityQuery request to get information about all the entities that are set up in the QuickBooks file. In an ARRefundCreditCard query, this must be a customer/customer job.
|
|
152
|
+
*
|
|
153
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
154
|
+
*/
|
|
155
|
+
entity_filter?: AccountFilter;
|
|
156
|
+
/**
|
|
157
|
+
* If you set `include_linked_txns` to true, then the returned object will include a list of all the transactions linked to the queried object. (This list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items.) Each linked transaction will be represented by a `linked_txn` aggregate.
|
|
158
|
+
*/
|
|
159
|
+
include_linked_txns?: boolean;
|
|
160
|
+
include_ret_element?: Array<"ARAccountRef" | "Amount" | "BalanceRemaining" | "BilledDate" | "ClassRef" | "CustomerRef" | "DataExtRet" | "Desc" | "DueDate" | "EditSequence" | "ExternalGUID" | "InventorySiteLocationRef" | "InventorySiteRef" | "IsPaid" | "ItemRef" | "LinkedTxn" | "OverrideUOMSetRef" | "Quantity" | "Rate" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber" | "UnitOfMeasure">;
|
|
161
|
+
/**
|
|
162
|
+
* 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 (25 with `include_linked_txns`); send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `ref_number`, `ref_number_case_sensitive` or `txn_id` every match comes back in one answer, so leave `iterator` out.
|
|
163
|
+
*/
|
|
164
|
+
iterator?: boolean;
|
|
165
|
+
/**
|
|
166
|
+
* 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.
|
|
167
|
+
*
|
|
168
|
+
* 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.
|
|
169
|
+
*
|
|
170
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
171
|
+
*
|
|
172
|
+
* Minimum 1.
|
|
173
|
+
*/
|
|
174
|
+
max_returned?: number;
|
|
175
|
+
/**
|
|
176
|
+
* 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.
|
|
177
|
+
*/
|
|
178
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
179
|
+
/**
|
|
180
|
+
* Filters according to the dates when transactions were last modified. The `modified_date_range_filter` aggregate isn’t required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `from_modified_date` and `to_modified_date` fields wasn’t supported in qbXML version 1.0 or 1.1.
|
|
181
|
+
*
|
|
182
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
183
|
+
*/
|
|
184
|
+
modified_date_range_filter?: ModifiedDateRangeFilter;
|
|
185
|
+
/**
|
|
186
|
+
* `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.
|
|
187
|
+
*/
|
|
188
|
+
owner_id?: string[];
|
|
189
|
+
/**
|
|
190
|
+
* Allows you to filter for transactions according to whether or not they are paid.
|
|
191
|
+
*
|
|
192
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
193
|
+
*/
|
|
194
|
+
paid_status?: "All" | "NotPaidOnly" | "PaidOnly";
|
|
195
|
+
/**
|
|
196
|
+
* `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
|
|
197
|
+
*
|
|
198
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
199
|
+
*/
|
|
200
|
+
ref_number?: string[];
|
|
201
|
+
/**
|
|
202
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
203
|
+
*/
|
|
204
|
+
ref_number_case_sensitive?: string[];
|
|
205
|
+
/**
|
|
206
|
+
* Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
|
|
207
|
+
*
|
|
208
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
209
|
+
*/
|
|
210
|
+
ref_number_filter?: RefNumberFilter;
|
|
211
|
+
/**
|
|
212
|
+
* Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
|
|
213
|
+
*
|
|
214
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
215
|
+
*/
|
|
216
|
+
ref_number_range_filter?: RefNumberRangeFilter;
|
|
217
|
+
/**
|
|
218
|
+
* 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`.
|
|
219
|
+
*/
|
|
220
|
+
request_id?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Filters according to the original transaction dates.
|
|
223
|
+
*
|
|
224
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
225
|
+
*/
|
|
226
|
+
txn_date_range_filter?: TxnDateRangeFilter;
|
|
227
|
+
/**
|
|
228
|
+
* `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
|
|
229
|
+
*
|
|
230
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `paid_status`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
231
|
+
*/
|
|
232
|
+
txn_id?: string[];
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* The params of `charge.update`: Update charge.
|
|
237
|
+
*/
|
|
238
|
+
export interface ChargeUpdateParams {
|
|
239
|
+
/**
|
|
240
|
+
* A monetary amount.
|
|
241
|
+
*/
|
|
242
|
+
amount?: number;
|
|
243
|
+
/**
|
|
244
|
+
* `ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
245
|
+
*/
|
|
246
|
+
ar_account_ref?: CurrencyRef;
|
|
247
|
+
/**
|
|
248
|
+
* The date when the customer was billed for what is now being charged to their credit card. (`billed_date` is the same as the date listed on an invoice or, for a statement charge, the date entered in the Statement Date field when the statement was printed.)
|
|
249
|
+
*
|
|
250
|
+
* Format: date.
|
|
251
|
+
*/
|
|
252
|
+
billed_date?: string;
|
|
253
|
+
/**
|
|
254
|
+
* 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.
|
|
255
|
+
*/
|
|
256
|
+
class_ref?: CurrencyRef;
|
|
257
|
+
/**
|
|
258
|
+
* `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
|
|
259
|
+
*/
|
|
260
|
+
customer_ref?: CurrencyRef;
|
|
261
|
+
/**
|
|
262
|
+
* A descriptive text field.
|
|
263
|
+
*/
|
|
264
|
+
desc?: string;
|
|
265
|
+
/**
|
|
266
|
+
* The date on which payment is due.
|
|
267
|
+
*
|
|
268
|
+
* Format: date.
|
|
269
|
+
*/
|
|
270
|
+
due_date?: string;
|
|
271
|
+
/**
|
|
272
|
+
* `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.
|
|
273
|
+
*/
|
|
274
|
+
edit_sequence: string;
|
|
275
|
+
include_ret_element?: Array<"ARAccountRef" | "Amount" | "BalanceRemaining" | "BilledDate" | "ClassRef" | "CustomerRef" | "DataExtRet" | "Desc" | "DueDate" | "EditSequence" | "ExternalGUID" | "InventorySiteLocationRef" | "InventorySiteRef" | "IsPaid" | "ItemRef" | "LinkedTxn" | "ListID" | "OverrideUOMSetRef" | "OwnerID" | "Quantity" | "Rate" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber" | "UnitOfMeasure">;
|
|
276
|
+
/**
|
|
277
|
+
* Location within the Inventory Site.
|
|
278
|
+
*/
|
|
279
|
+
inventory_site_location_ref?: CurrencyRef;
|
|
280
|
+
/**
|
|
281
|
+
* Site where inventory is located.
|
|
282
|
+
*/
|
|
283
|
+
inventory_site_ref?: CurrencyRef;
|
|
284
|
+
/**
|
|
285
|
+
* `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
286
|
+
*/
|
|
287
|
+
item_ref?: CurrencyRef;
|
|
288
|
+
/**
|
|
289
|
+
* Flag to override price rule conflict
|
|
290
|
+
*/
|
|
291
|
+
option_for_price_rule_conflict?: "BasePrice" | "Zero";
|
|
292
|
+
/**
|
|
293
|
+
* Refers to a QuickBooks account. If an `override_item_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
294
|
+
*/
|
|
295
|
+
override_item_account_ref?: CurrencyRef;
|
|
296
|
+
/**
|
|
297
|
+
* When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you can’t change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request.
|
|
298
|
+
*/
|
|
299
|
+
override_uom_set_ref?: CurrencyRef;
|
|
300
|
+
/**
|
|
301
|
+
* On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
|
|
302
|
+
*/
|
|
303
|
+
quantity?: number;
|
|
304
|
+
/**
|
|
305
|
+
* Indicates the price of something.
|
|
306
|
+
*/
|
|
307
|
+
rate?: number;
|
|
308
|
+
/**
|
|
309
|
+
* `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
|
|
310
|
+
*/
|
|
311
|
+
ref_number?: string;
|
|
312
|
+
/**
|
|
313
|
+
* 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`.
|
|
314
|
+
*/
|
|
315
|
+
request_id?: string;
|
|
316
|
+
/**
|
|
317
|
+
* 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.
|
|
318
|
+
*
|
|
319
|
+
* Format: date.
|
|
320
|
+
*/
|
|
321
|
+
txn_date?: string;
|
|
322
|
+
/**
|
|
323
|
+
* `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
|
|
324
|
+
*/
|
|
325
|
+
txn_id: string;
|
|
326
|
+
/**
|
|
327
|
+
* In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
|
|
328
|
+
*/
|
|
329
|
+
unit_of_measure?: string;
|
|
330
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks charge operations. Types: charge.d.ts. */
|
|
5
|
+
class Charge {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create charge.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./charge").ChargeCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/charges/create-charge
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("charge.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List charges (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./charge").ChargeQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/charges/list-charges
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("charge.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update charge.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./charge").ChargeUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/charges/update-charge
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("charge.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { Charge };
|