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,89 @@
|
|
|
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 form1099 category account mapping operations: `qube.form1099CategoryAccountMapping.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Form1099CategoryAccountMapping {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List form1099 category account mappings: `GET /connections/{connection_id}/form1099-category-account-mappings`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `form_type`, `mapping_category`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/form1099-category-account-mappings/list-form1099-category-account-mappings
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: Form1099CategoryAccountMappingQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* Update form1099 category account mapping: `PUT /connections/{connection_id}/form1099-category-account-mappings`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
25
|
+
* Params go in the JSON body.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `category_account_mapping_mod`, `is_filing1099_misc`, `request_id`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/form1099-category-account-mappings/update-form1099-category-account-mapping
|
|
31
|
+
*/
|
|
32
|
+
update(connectionId: string, params: Form1099CategoryAccountMappingUpdateParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `form1099_category_account_mapping.query`: List form1099 category account mappings.
|
|
37
|
+
*/
|
|
38
|
+
export interface Form1099CategoryAccountMappingQueryParams {
|
|
39
|
+
/**
|
|
40
|
+
* Added a form type to support Form 1099-NEC and Form 1099-MISC. `form_type` is a property to identify the type of form (MISC/NEC) for which Form1099CategoryAccountMapping query is run. Form type will be MISC if no `form_type` is specified.
|
|
41
|
+
*/
|
|
42
|
+
form_type?: string;
|
|
43
|
+
/**
|
|
44
|
+
* A mapping category indicates the form 1099 box that one or more accounts is being mapped to. You must specify one of the following enumerated values based on the form type:
|
|
45
|
+
*/
|
|
46
|
+
mapping_category?: Array<"BOX1" | "BOX10" | "BOX13" | "BOX14" | "BOX2" | "BOX3" | "BOX4" | "BOX5" | "BOX6" | "BOX7" | "BOX8" | "BOX9">;
|
|
47
|
+
/**
|
|
48
|
+
* 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`.
|
|
49
|
+
*/
|
|
50
|
+
request_id?: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* The params of `form1099_category_account_mapping.update`: Update form1099 category account mapping.
|
|
55
|
+
*/
|
|
56
|
+
export interface Form1099CategoryAccountMappingUpdateParams {
|
|
57
|
+
category_account_mapping_mod?: CategoryAccountMappingMod[];
|
|
58
|
+
/**
|
|
59
|
+
* This property reports only (it doesn’t set!) the current status of 1099 preferences setting in the company file. The value true indicates that the company file currently has the 1099 filing preference turned on. The value false indicates that the company file isn’t currently set to file 1099-MISC and 1099-NEC forms.
|
|
60
|
+
*/
|
|
61
|
+
is_filing1099_misc?: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* 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`.
|
|
64
|
+
*/
|
|
65
|
+
request_id?: string;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface CategoryAccountMappingMod {
|
|
69
|
+
mapping_account?: MappingAccount[];
|
|
70
|
+
/**
|
|
71
|
+
* A mapping category indicates the form 1099 box that one or more accounts is being mapped to. You must specify one of the following enumerated values based on the form type:
|
|
72
|
+
*/
|
|
73
|
+
mapping_category: "BOX1" | "BOX10" | "BOX13" | "BOX14" | "BOX2" | "BOX3" | "BOX4" | "BOX5" | "BOX6" | "BOX7" | "BOX8" | "BOX9";
|
|
74
|
+
/**
|
|
75
|
+
* This is the dollar amount at which the IRS requires you to file the 1099-MISC and 1099-NEC forms. Each box (“Category” in SDK lingo) can have a separate threshold, as established by the IRS. For the latest thresholds, check the website for the Internal Revenue Service, currently at www.irs.gov.
|
|
76
|
+
*/
|
|
77
|
+
threshold?: number;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export interface MappingAccount {
|
|
81
|
+
/**
|
|
82
|
+
* `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.
|
|
83
|
+
*/
|
|
84
|
+
account_ref: CurrencyRef;
|
|
85
|
+
/**
|
|
86
|
+
* In some circumstances, changing the account mapping could result in the displaying of a user dialog in the QuickBooks UI prompting the user to confirm, which would prevent the SDK request from completing. Setting this property to true causes that user dialog to be suppressed.
|
|
87
|
+
*/
|
|
88
|
+
force_mapping?: boolean;
|
|
89
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks form1099 category account mapping operations. Types: form1099_category_account_mapping.d.ts. */
|
|
5
|
+
class Form1099CategoryAccountMapping {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List form1099 category account mappings.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./form1099_category_account_mapping").Form1099CategoryAccountMappingQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/form1099-category-account-mappings/list-form1099-category-account-mappings
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("form1099_category_account_mapping.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Update form1099 category account mapping.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./form1099_category_account_mapping").Form1099CategoryAccountMappingUpdateParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/form1099-category-account-mappings/update-form1099-category-account-mapping
|
|
32
|
+
*/
|
|
33
|
+
update(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("form1099_category_account_mapping.update", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
module.exports = { Form1099CategoryAccountMapping };
|
|
@@ -0,0 +1,108 @@
|
|
|
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, ReportAccountFilter, ReportClassFilter, ReportEntityFilter, ReportItemFilter, ReportModifiedDateRangeFilter, ReportPeriod, ReportTxnTypeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks general detail report operations: `qube.generalDetailReport.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class GeneralDetailReport {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List general detail reports: `GET /connections/{connection_id}/general-detail-reports`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `display_report`, `general_detail_report_type` (required), `include_accounts`, `include_column`, `report_account_filter`, `report_basis`, `report_class_filter`, `report_date_macro`, `report_detail_level_filter`, `report_entity_filter`, `report_item_filter`, `report_modified_date_range_filter`, `report_modified_date_range_macro`, `report_open_balance_as_of`, `report_period`, `report_posting_status_filter`, `report_txn_type_filter`, `request_id`, `summarize_rows_by`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/general-detail-reports/list-general-detail-reports
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: GeneralDetailReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `general_detail_report.query`: List general detail reports.
|
|
25
|
+
*/
|
|
26
|
+
export interface GeneralDetailReportQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
|
|
29
|
+
*/
|
|
30
|
+
display_report?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* The type of general detail report to return. (If you specify gdrtMissingChecks, you must also specify an account type in the account filter.)
|
|
33
|
+
*/
|
|
34
|
+
general_detail_report_type: "1099Detail" | "AuditTrail" | "BalanceSheetDetail" | "CheckDetail" | "CustomerBalanceDetail" | "DepositDetail" | "EstimatesByJob" | "ExpenseByVendorDetail" | "GeneralLedger" | "IncomeByCustomerDetail" | "IncomeTaxDetail" | "InventoryValuationDetail" | "JobProgressInvoicesVsEstimates" | "Journal" | "MissingChecks" | "OpenInvoices" | "OpenPOs" | "OpenPOsByJob" | "OpenSalesOrderByCustomer" | "OpenSalesOrderByItem" | "PendingSales" | "ProfitAndLossDetail" | "PurchaseByItemDetail" | "PurchaseByVendorDetail" | "SalesByCustomerDetail" | "SalesByItemDetail" | "SalesByRepDetail" | "TxnDetailByAccount" | "TxnListByCustomer" | "TxnListByDate" | "TxnListByVendor" | "UnbilledCostsByJob" | "UnpaidBillsDetail" | "VendorBalanceDetail";
|
|
35
|
+
/**
|
|
36
|
+
* Indicates whether this report should include all accounts or just those that are currently in use.
|
|
37
|
+
*/
|
|
38
|
+
include_accounts?: "All" | "InUse";
|
|
39
|
+
include_column?: Array<"Account" | "Aging" | "Amount" | "AmountDifference" | "AverageCost" | "BilledDate" | "BillingStatus" | "CalculatedAmount" | "Class" | "ClearedStatus" | "CostPrice" | "Credit" | "Currency" | "Date" | "Debit" | "DeliveryDate" | "DueDate" | "EstimateActive" | "ExchangeRate" | "FOB" | "IncomeSubjectToTax" | "Invoiced" | "Item" | "ItemDesc" | "LastModifiedBy" | "LatestOrPriorState" | "Memo" | "ModifiedTime" | "Name" | "NameAccountNumber" | "NameAddress" | "NameCity" | "NameContact" | "NameEmail" | "NameFax" | "NamePhone" | "NameState" | "NameZip" | "OpenBalance" | "OriginalAmount" | "PONumber" | "PaidAmount" | "PaidStatus" | "PaidThroughDate" | "PaymentMethod" | "PayrollItem" | "PrintStatus" | "ProgressAmount" | "ProgressPercent" | "Quantity" | "QuantityAvailable" | "QuantityOnHand" | "QuantityOnSalesOrder" | "ReceivedQuantity" | "RefNumber" | "RunningBalance" | "SSNOrTaxID" | "SalesRep" | "SalesTaxCode" | "SerialOrLotNumber" | "ShipDate" | "ShipMethod" | "SourceName" | "SplitAccount" | "TaxLine" | "TaxTableVersion" | "Terms" | "TxnID" | "TxnNumber" | "TxnType" | "UnitPrice" | "UserEdit" | "ValueOnHand" | "WageBase" | "WageBaseTips">;
|
|
40
|
+
/**
|
|
41
|
+
* Allows you to query for a specified account type or for specific list elements.
|
|
42
|
+
*/
|
|
43
|
+
report_account_filter?: ReportAccountFilter;
|
|
44
|
+
/**
|
|
45
|
+
* If `report_basis` is rbCash, the report bases income and expenses on the dates when money changed hands.rbAccrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered.rbNone, the report uses the default `report_basis`, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report.
|
|
46
|
+
*/
|
|
47
|
+
report_basis?: "Accrual" | "Cash" | "None";
|
|
48
|
+
/**
|
|
49
|
+
* Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
50
|
+
*/
|
|
51
|
+
report_class_filter?: ReportClassFilter;
|
|
52
|
+
/**
|
|
53
|
+
* The time period covered by this report.
|
|
54
|
+
*
|
|
55
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
56
|
+
*/
|
|
57
|
+
report_date_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
|
|
58
|
+
/**
|
|
59
|
+
* The level of detail to include in the report.
|
|
60
|
+
*/
|
|
61
|
+
report_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
|
|
62
|
+
/**
|
|
63
|
+
* Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
|
|
64
|
+
*/
|
|
65
|
+
report_entity_filter?: ReportEntityFilter;
|
|
66
|
+
/**
|
|
67
|
+
* Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
|
|
68
|
+
*/
|
|
69
|
+
report_item_filter?: ReportItemFilter;
|
|
70
|
+
/**
|
|
71
|
+
* Returns reports that were modified between these two dates (inclusive). The range of acceptable dates for both `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
|
|
72
|
+
*
|
|
73
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
74
|
+
*/
|
|
75
|
+
report_modified_date_range_filter?: ReportModifiedDateRangeFilter;
|
|
76
|
+
/**
|
|
77
|
+
* The time period covered by this report.
|
|
78
|
+
*
|
|
79
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
80
|
+
*/
|
|
81
|
+
report_modified_date_range_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
|
|
82
|
+
/**
|
|
83
|
+
* The report will return open balance information up to the `report_open_balance_as_of` date.
|
|
84
|
+
*/
|
|
85
|
+
report_open_balance_as_of?: "ReportEndDate" | "Today";
|
|
86
|
+
/**
|
|
87
|
+
* If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
|
|
88
|
+
*
|
|
89
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
90
|
+
*/
|
|
91
|
+
report_period?: ReportPeriod;
|
|
92
|
+
/**
|
|
93
|
+
* Allows you to query for posting reports, non-posting reports, or reports that are either one.
|
|
94
|
+
*/
|
|
95
|
+
report_posting_status_filter?: "Either" | "NonPosting" | "Posting";
|
|
96
|
+
/**
|
|
97
|
+
* Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
|
|
98
|
+
*/
|
|
99
|
+
report_txn_type_filter?: ReportTxnTypeFilter;
|
|
100
|
+
/**
|
|
101
|
+
* 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`.
|
|
102
|
+
*/
|
|
103
|
+
request_id?: string;
|
|
104
|
+
/**
|
|
105
|
+
* `summarize_rows_by` (along with IncludeColumnList, in most cases) determines what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to srbAccount, the report’s row labels might be “Checking,” “Savings,” and so on.
|
|
106
|
+
*/
|
|
107
|
+
summarize_rows_by?: "Account" | "BalanceSheet" | "Class" | "Customer" | "CustomerType" | "Day" | "Employee" | "FourWeek" | "HalfMonth" | "IncomeStatement" | "ItemDetail" | "ItemType" | "Month" | "Payee" | "PaymentMethod" | "PayrollItemDetail" | "PayrollYtdDetail" | "Quarter" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "TaxLine" | "Terms" | "TotalOnly" | "TwoWeek" | "Vendor" | "VendorType" | "Week" | "Year";
|
|
108
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks general detail report operations. Types: general_detail_report.d.ts. */
|
|
5
|
+
class GeneralDetailReport {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List general detail reports.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./general_detail_report").GeneralDetailReportQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/general-detail-reports/list-general-detail-reports
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("general_detail_report.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { GeneralDetailReport };
|
|
@@ -0,0 +1,115 @@
|
|
|
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, ReportAccountFilter, ReportClassFilter, ReportEntityFilter, ReportItemFilter, ReportModifiedDateRangeFilter, ReportPeriod, ReportTxnTypeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks general summary report operations: `qube.generalSummaryReport.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class GeneralSummaryReport {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List general summary reports: `GET /connections/{connection_id}/general-summary-reports`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `display_report`, `general_summary_report_type` (required), `include_subcolumns`, `report_account_filter`, `report_basis`, `report_calendar`, `report_class_filter`, `report_date_macro`, `report_detail_level_filter`, `report_entity_filter`, `report_item_filter`, `report_modified_date_range_filter`, `report_modified_date_range_macro`, `report_period`, `report_posting_status_filter`, `report_txn_type_filter`, `request_id`, `return_columns`, `return_rows`, `summarize_columns_by`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/general-summary-reports/list-general-summary-reports
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: GeneralSummaryReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `general_summary_report.query`: List general summary reports.
|
|
25
|
+
*/
|
|
26
|
+
export interface GeneralSummaryReportQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
|
|
29
|
+
*/
|
|
30
|
+
display_report?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* The type of general summary report being queried. The report types listed below map almost directly to named reports in QuickBooks.
|
|
33
|
+
*/
|
|
34
|
+
general_summary_report_type: "BalanceSheetByClass" | "BalanceSheetPrevYearComp" | "BalanceSheetStandard" | "BalanceSheetSummary" | "CustomerBalanceSummary" | "ExpenseByVendorSummary" | "IncomeByCustomerSummary" | "IncomeTaxSummary" | "InventoryStockStatusByItem" | "InventoryStockStatusByVendor" | "InventoryValuationSummary" | "InventoryValuationSummaryBySite" | "LotNumberInStockBySite" | "PhysicalInventoryWorksheet" | "ProfitAndLossByClass" | "ProfitAndLossByJob" | "ProfitAndLossPrevYearComp" | "ProfitAndLossStandard" | "ProfitAndLossYTDComp" | "PurchaseByItemSummary" | "PurchaseByVendorSummary" | "SalesByCustomerSummary" | "SalesByItemSummary" | "SalesByRepSummary" | "SalesTaxLiability" | "SalesTaxRevenueSummary" | "SerialNumberInStockBySite" | "TrialBalance" | "VendorBalanceSummary";
|
|
35
|
+
/**
|
|
36
|
+
* The default value is false, which means that the report won’t include any subcolumn information. To include all available types of subcolumns for this report, set `include_subcolumns` to true. The SDK won’t return subcolumn information for data that can be easily computed. (For example, the SDK doesn’t return the “percent of row” column.)
|
|
37
|
+
*/
|
|
38
|
+
include_subcolumns?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Allows you to query for a specified account type or for specific list elements.
|
|
41
|
+
*/
|
|
42
|
+
report_account_filter?: ReportAccountFilter;
|
|
43
|
+
/**
|
|
44
|
+
* If `report_basis` is rbCash, the report bases income and expenses on the dates when money changed hands.rbAccrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered.rbNone, the report uses the default `report_basis`, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report.
|
|
45
|
+
*/
|
|
46
|
+
report_basis?: "Accrual" | "Cash" | "None";
|
|
47
|
+
/**
|
|
48
|
+
* Specifies the type of year that will be used for this report.
|
|
49
|
+
*/
|
|
50
|
+
report_calendar?: "CalendarYear" | "FiscalYear" | "TaxYear";
|
|
51
|
+
/**
|
|
52
|
+
* Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
53
|
+
*/
|
|
54
|
+
report_class_filter?: ReportClassFilter;
|
|
55
|
+
/**
|
|
56
|
+
* The time period covered by this report.
|
|
57
|
+
*
|
|
58
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
59
|
+
*/
|
|
60
|
+
report_date_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
|
|
61
|
+
/**
|
|
62
|
+
* The level of detail to include in the report.
|
|
63
|
+
*/
|
|
64
|
+
report_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
|
|
65
|
+
/**
|
|
66
|
+
* Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
|
|
67
|
+
*/
|
|
68
|
+
report_entity_filter?: ReportEntityFilter;
|
|
69
|
+
/**
|
|
70
|
+
* Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
|
|
71
|
+
*/
|
|
72
|
+
report_item_filter?: ReportItemFilter;
|
|
73
|
+
/**
|
|
74
|
+
* Returns reports that were modified between these two dates (inclusive). The range of acceptable dates for both `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
|
|
75
|
+
*
|
|
76
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
77
|
+
*/
|
|
78
|
+
report_modified_date_range_filter?: ReportModifiedDateRangeFilter;
|
|
79
|
+
/**
|
|
80
|
+
* The time period covered by this report.
|
|
81
|
+
*
|
|
82
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
83
|
+
*/
|
|
84
|
+
report_modified_date_range_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
|
|
85
|
+
/**
|
|
86
|
+
* If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
|
|
87
|
+
*
|
|
88
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
89
|
+
*/
|
|
90
|
+
report_period?: ReportPeriod;
|
|
91
|
+
/**
|
|
92
|
+
* Allows you to query for posting reports, non-posting reports, or reports that are either one.
|
|
93
|
+
*/
|
|
94
|
+
report_posting_status_filter?: "Either" | "NonPosting" | "Posting";
|
|
95
|
+
/**
|
|
96
|
+
* Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
|
|
97
|
+
*/
|
|
98
|
+
report_txn_type_filter?: ReportTxnTypeFilter;
|
|
99
|
+
/**
|
|
100
|
+
* 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`.
|
|
101
|
+
*/
|
|
102
|
+
request_id?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
|
|
105
|
+
*/
|
|
106
|
+
return_columns?: "ActiveOnly" | "All" | "NonZero";
|
|
107
|
+
/**
|
|
108
|
+
* Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
|
|
109
|
+
*/
|
|
110
|
+
return_rows?: "ActiveOnly" | "All" | "NonZero";
|
|
111
|
+
/**
|
|
112
|
+
* `summarize_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report. For example, if you set the value to scbTwoWeek, the report’s column labels might be “Feb 10-23, 02,” “Feb 24-Mar9, 02,” and so on.
|
|
113
|
+
*/
|
|
114
|
+
summarize_columns_by?: "Account" | "BalanceSheet" | "Class" | "Customer" | "CustomerType" | "Day" | "Employee" | "FourWeek" | "HalfMonth" | "IncomeStatement" | "ItemDetail" | "ItemType" | "Month" | "Payee" | "PaymentMethod" | "PayrollItemDetail" | "PayrollYtdDetail" | "Quarter" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "Terms" | "TotalOnly" | "TwoWeek" | "Vendor" | "VendorType" | "Week" | "Year";
|
|
115
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks general summary report operations. Types: general_summary_report.d.ts. */
|
|
5
|
+
class GeneralSummaryReport {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List general summary reports.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./general_summary_report").GeneralSummaryReportQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/general-summary-reports/list-general-summary-reports
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("general_summary_report.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { GeneralSummaryReport };
|
|
@@ -0,0 +1,43 @@
|
|
|
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 } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks host operations: `qube.host.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Host {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List hosts: `GET /connections/{connection_id}/hosts`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `include_list_meta_data`, `include_ret_element`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/hosts/list-hosts
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: HostQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `host.query`: List hosts.
|
|
25
|
+
*/
|
|
26
|
+
export interface HostQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Use this aggregate if you want the query to return list capacity metadata for each object type in QuickBooks.
|
|
29
|
+
*/
|
|
30
|
+
include_list_meta_data?: IncludeListMetaData;
|
|
31
|
+
include_ret_element?: Array<"Country" | "IsAutomaticLogin" | "ListMetaData" | "MajorVersion" | "MinorVersion" | "ProductName" | "QBFileMode" | "SupportedQBXMLVersion">;
|
|
32
|
+
/**
|
|
33
|
+
* 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`.
|
|
34
|
+
*/
|
|
35
|
+
request_id?: string;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export interface IncludeListMetaData {
|
|
39
|
+
/**
|
|
40
|
+
* Specify the value “true” to return max list limits for each object type, or “false” to not return these in the query response. By default, this is “false” for HostQuery.
|
|
41
|
+
*/
|
|
42
|
+
include_max_capacity: boolean;
|
|
43
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks host operations. Types: host.d.ts. */
|
|
5
|
+
class Host {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List hosts.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./host").HostQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/hosts/list-hosts
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("host.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { Host };
|