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,58 @@
|
|
|
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 list merge operations: `qube.listMerge.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ListMerge {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Execute list merge: `POST /connections/{connection_id}/list-merge`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `list_merge_type` (required), `merge_from` (required), `merge_to` (required), `request_id`, `same_ship_addr_ok`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-merge/execute-list-merge
|
|
19
|
+
*/
|
|
20
|
+
execute(connectionId: string, params: ListMergeExecuteParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `list_merge.execute`: Execute list merge.
|
|
25
|
+
*/
|
|
26
|
+
export interface ListMergeExecuteParams {
|
|
27
|
+
/**
|
|
28
|
+
* The type of the objects to be merged. Both of the objects must be the same type, for example both must be customers, because you can’t merge a vendor with a customer.
|
|
29
|
+
*/
|
|
30
|
+
list_merge_type: "Account" | "Class" | "Customer" | "ItemDiscount" | "ItemGroup" | "ItemInventory" | "ItemNonInventory" | "ItemOtherCharge" | "ItemPayment" | "ItemSalesTax" | "ItemSalesTaxGroup" | "ItemService" | "ItemSubtotal" | "Vendor";
|
|
31
|
+
/**
|
|
32
|
+
* The object to be merged into another object.
|
|
33
|
+
*/
|
|
34
|
+
merge_from: MergeFrom;
|
|
35
|
+
/**
|
|
36
|
+
* The object into which you are merging another object.
|
|
37
|
+
*/
|
|
38
|
+
merge_to: MergeFrom;
|
|
39
|
+
/**
|
|
40
|
+
* 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`.
|
|
41
|
+
*/
|
|
42
|
+
request_id?: string;
|
|
43
|
+
/**
|
|
44
|
+
* A new tag (SameshipAddressOk) is added to ListMerge request. If true is supplied in this tag then the merge will go through even if elements have same default shipto address.
|
|
45
|
+
*/
|
|
46
|
+
same_ship_addr_ok?: boolean;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export interface MergeFrom {
|
|
50
|
+
/**
|
|
51
|
+
* `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.
|
|
52
|
+
*/
|
|
53
|
+
edit_sequence: string;
|
|
54
|
+
/**
|
|
55
|
+
* `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`.
|
|
56
|
+
*/
|
|
57
|
+
list_id: string;
|
|
58
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks list merge operations. Types: list_merge.d.ts. */
|
|
5
|
+
class ListMerge {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Execute list merge.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./list_merge").ListMergeExecuteParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-merge/execute-list-merge
|
|
20
|
+
*/
|
|
21
|
+
execute(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("list_merge.execute", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { ListMerge };
|
|
@@ -0,0 +1,280 @@
|
|
|
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, Address, NameFilter, NameRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks other name operations: `qube.otherName.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class OtherName {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create other name: `POST /connections/{connection_id}/other-names`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `account_number`, `alt_contact`, `alt_phone`, `company_name`, `contact`, `email`, `external_guid`, `fax`, `first_name`, `include_ret_element`, `is_active`, `last_name`, `middle_name`, `name` (required), `notes`, `other_name_address`, `phone`, `request_id`, `salutation`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/other-names/create-other-name
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: OtherNameCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List other names: `GET /connections/{connection_id}/other-names`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `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/other-names/list-other-names
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: OtherNameQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update other name: `PUT /connections/{connection_id}/other-names`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `account_number`, `alt_contact`, `alt_phone`, `company_name`, `contact`, `edit_sequence` (required), `email`, `fax`, `first_name`, `include_ret_element`, `is_active`, `last_name`, `list_id` (required), `middle_name`, `name`, `notes`, `other_name_address`, `phone`, `request_id`, `salutation`.
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/other-names/update-other-name
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: OtherNameUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `other_name.create`: Create other name.
|
|
49
|
+
*/
|
|
50
|
+
export interface OtherNameCreateParams {
|
|
51
|
+
/**
|
|
52
|
+
* Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers won’t be visible in the user interface.
|
|
53
|
+
*/
|
|
54
|
+
account_number?: string;
|
|
55
|
+
/**
|
|
56
|
+
* The name of an alternate contact person for a vendor, customer, or “other name” entry.
|
|
57
|
+
*/
|
|
58
|
+
alt_contact?: string;
|
|
59
|
+
/**
|
|
60
|
+
* A telephone number given as an alternative to Phone.
|
|
61
|
+
*/
|
|
62
|
+
alt_phone?: string;
|
|
63
|
+
/**
|
|
64
|
+
* The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.)
|
|
65
|
+
*/
|
|
66
|
+
company_name?: string;
|
|
67
|
+
/**
|
|
68
|
+
* The name of a contact person for a customer or vendor.
|
|
69
|
+
*/
|
|
70
|
+
contact?: string;
|
|
71
|
+
/**
|
|
72
|
+
* E-mail address.
|
|
73
|
+
*/
|
|
74
|
+
email?: string;
|
|
75
|
+
/**
|
|
76
|
+
* Allows for the attachment of a user defined GUID value.
|
|
77
|
+
*/
|
|
78
|
+
external_guid?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Fax number.
|
|
81
|
+
*/
|
|
82
|
+
fax?: string;
|
|
83
|
+
/**
|
|
84
|
+
* The first name of a customer, vendor, employee, or person on the “other names” list.
|
|
85
|
+
*/
|
|
86
|
+
first_name?: string;
|
|
87
|
+
include_ret_element?: Array<"AccountNumber" | "AltContact" | "AltPhone" | "CompanyName" | "Contact" | "DataExtRet" | "EditSequence" | "Email" | "ExternalGUID" | "Fax" | "FirstName" | "IsActive" | "LastName" | "ListID" | "MiddleName" | "Name" | "Notes" | "OtherNameAddress" | "OtherNameAddressBlock" | "OwnerID" | "Phone" | "Salutation" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
88
|
+
/**
|
|
89
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
90
|
+
*/
|
|
91
|
+
is_active?: boolean;
|
|
92
|
+
/**
|
|
93
|
+
* The last name of a customer, vendor, employee, or person on the “other names” list.
|
|
94
|
+
*/
|
|
95
|
+
last_name?: string;
|
|
96
|
+
/**
|
|
97
|
+
* The middle name of a customer, vendor, employee, or person on the “other names” list.
|
|
98
|
+
*/
|
|
99
|
+
middle_name?: string;
|
|
100
|
+
/**
|
|
101
|
+
* 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 FullName remains distinct.
|
|
102
|
+
*/
|
|
103
|
+
name: string;
|
|
104
|
+
/**
|
|
105
|
+
* Additional information.
|
|
106
|
+
*/
|
|
107
|
+
notes?: string;
|
|
108
|
+
/**
|
|
109
|
+
* If an address request fails, some combination of address fields might be too long.
|
|
110
|
+
*/
|
|
111
|
+
other_name_address?: Address;
|
|
112
|
+
/**
|
|
113
|
+
* The telephone number.
|
|
114
|
+
*/
|
|
115
|
+
phone?: string;
|
|
116
|
+
/**
|
|
117
|
+
* 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`.
|
|
118
|
+
*/
|
|
119
|
+
request_id?: string;
|
|
120
|
+
/**
|
|
121
|
+
* A formal reference, such as Mr. or Dr., that precedes a name.
|
|
122
|
+
*/
|
|
123
|
+
salutation?: string;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* The params of `other_name.query`: List other names.
|
|
128
|
+
*/
|
|
129
|
+
export interface OtherNameQueryParams {
|
|
130
|
+
/**
|
|
131
|
+
* 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.
|
|
132
|
+
*
|
|
133
|
+
* 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.
|
|
134
|
+
*/
|
|
135
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
136
|
+
/**
|
|
137
|
+
* 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.
|
|
138
|
+
*
|
|
139
|
+
* 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.
|
|
140
|
+
*
|
|
141
|
+
* Format: date-time.
|
|
142
|
+
*/
|
|
143
|
+
from_modified_date?: string;
|
|
144
|
+
/**
|
|
145
|
+
* 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.
|
|
146
|
+
*/
|
|
147
|
+
full_name?: string[];
|
|
148
|
+
include_ret_element?: Array<"AccountNumber" | "AltContact" | "AltPhone" | "CompanyName" | "Contact" | "DataExtRet" | "EditSequence" | "Email" | "ExternalGUID" | "Fax" | "FirstName" | "IsActive" | "LastName" | "ListID" | "MiddleName" | "Name" | "Notes" | "OtherNameAddress" | "OtherNameAddressBlock" | "Phone" | "Salutation" | "TimeCreated" | "TimeModified">;
|
|
149
|
+
/**
|
|
150
|
+
* `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`.
|
|
151
|
+
*
|
|
152
|
+
* 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.
|
|
153
|
+
*/
|
|
154
|
+
list_id?: string[];
|
|
155
|
+
/**
|
|
156
|
+
* 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.
|
|
157
|
+
*
|
|
158
|
+
* QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
|
|
159
|
+
*
|
|
160
|
+
* 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.
|
|
161
|
+
*
|
|
162
|
+
* Minimum 1.
|
|
163
|
+
*/
|
|
164
|
+
max_returned?: number;
|
|
165
|
+
/**
|
|
166
|
+
* 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.
|
|
167
|
+
*/
|
|
168
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
169
|
+
/**
|
|
170
|
+
* Filters according to the object’s Name.
|
|
171
|
+
*
|
|
172
|
+
* 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.
|
|
173
|
+
*/
|
|
174
|
+
name_filter?: NameFilter;
|
|
175
|
+
/**
|
|
176
|
+
* Filters according to the object’s Name.
|
|
177
|
+
*
|
|
178
|
+
* 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.
|
|
179
|
+
*/
|
|
180
|
+
name_range_filter?: NameRangeFilter;
|
|
181
|
+
/**
|
|
182
|
+
* `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.
|
|
183
|
+
*/
|
|
184
|
+
owner_id?: string[];
|
|
185
|
+
/**
|
|
186
|
+
* 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`.
|
|
187
|
+
*/
|
|
188
|
+
request_id?: string;
|
|
189
|
+
/**
|
|
190
|
+
* 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).
|
|
191
|
+
*
|
|
192
|
+
* 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.
|
|
193
|
+
*
|
|
194
|
+
* Format: date-time.
|
|
195
|
+
*/
|
|
196
|
+
to_modified_date?: string;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* The params of `other_name.update`: Update other name.
|
|
201
|
+
*/
|
|
202
|
+
export interface OtherNameUpdateParams {
|
|
203
|
+
/**
|
|
204
|
+
* Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers won’t be visible in the user interface.
|
|
205
|
+
*/
|
|
206
|
+
account_number?: string;
|
|
207
|
+
/**
|
|
208
|
+
* The name of an alternate contact person for a vendor, customer, or “other name” entry.
|
|
209
|
+
*/
|
|
210
|
+
alt_contact?: string;
|
|
211
|
+
/**
|
|
212
|
+
* A telephone number given as an alternative to Phone.
|
|
213
|
+
*/
|
|
214
|
+
alt_phone?: string;
|
|
215
|
+
/**
|
|
216
|
+
* The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.)
|
|
217
|
+
*/
|
|
218
|
+
company_name?: string;
|
|
219
|
+
/**
|
|
220
|
+
* The name of a contact person for a customer or vendor.
|
|
221
|
+
*/
|
|
222
|
+
contact?: string;
|
|
223
|
+
/**
|
|
224
|
+
* `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes.
|
|
225
|
+
*/
|
|
226
|
+
edit_sequence: string;
|
|
227
|
+
/**
|
|
228
|
+
* E-mail address.
|
|
229
|
+
*/
|
|
230
|
+
email?: string;
|
|
231
|
+
/**
|
|
232
|
+
* Fax number.
|
|
233
|
+
*/
|
|
234
|
+
fax?: string;
|
|
235
|
+
/**
|
|
236
|
+
* The first name of a customer, vendor, employee, or person on the “other names” list.
|
|
237
|
+
*/
|
|
238
|
+
first_name?: string;
|
|
239
|
+
include_ret_element?: Array<"AccountNumber" | "AltContact" | "AltPhone" | "CompanyName" | "Contact" | "DataExtRet" | "EditSequence" | "Email" | "ExternalGUID" | "Fax" | "FirstName" | "IsActive" | "LastName" | "ListID" | "MiddleName" | "Name" | "Notes" | "OtherNameAddress" | "OtherNameAddressBlock" | "OwnerID" | "Phone" | "Salutation" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
240
|
+
/**
|
|
241
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
242
|
+
*/
|
|
243
|
+
is_active?: boolean;
|
|
244
|
+
/**
|
|
245
|
+
* The last name of a customer, vendor, employee, or person on the “other names” list.
|
|
246
|
+
*/
|
|
247
|
+
last_name?: string;
|
|
248
|
+
/**
|
|
249
|
+
* `list_id` and FullName 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 FullName and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores FullName.
|
|
250
|
+
*/
|
|
251
|
+
list_id: string;
|
|
252
|
+
/**
|
|
253
|
+
* The middle name of a customer, vendor, employee, or person on the “other names” list.
|
|
254
|
+
*/
|
|
255
|
+
middle_name?: string;
|
|
256
|
+
/**
|
|
257
|
+
* 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 FullName remains distinct.
|
|
258
|
+
*/
|
|
259
|
+
name?: string;
|
|
260
|
+
/**
|
|
261
|
+
* Additional information.
|
|
262
|
+
*/
|
|
263
|
+
notes?: string;
|
|
264
|
+
/**
|
|
265
|
+
* If an address request fails, some combination of address fields might be too long.
|
|
266
|
+
*/
|
|
267
|
+
other_name_address?: Address;
|
|
268
|
+
/**
|
|
269
|
+
* The telephone number.
|
|
270
|
+
*/
|
|
271
|
+
phone?: string;
|
|
272
|
+
/**
|
|
273
|
+
* 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`.
|
|
274
|
+
*/
|
|
275
|
+
request_id?: string;
|
|
276
|
+
/**
|
|
277
|
+
* A formal reference, such as Mr. or Dr., that precedes a name.
|
|
278
|
+
*/
|
|
279
|
+
salutation?: string;
|
|
280
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks other name operations. Types: other_name.d.ts. */
|
|
5
|
+
class OtherName {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create other name.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./other_name").OtherNameCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/other-names/create-other-name
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("other_name.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List other names.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./other_name").OtherNameQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/other-names/list-other-names
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("other_name.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update other name.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./other_name").OtherNameUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/other-names/update-other-name
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("other_name.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { OtherName };
|
|
@@ -0,0 +1,82 @@
|
|
|
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, AccountFilterPaycheck, ModifiedDateRangeFilterPaycheck, PayrollDateRangeFilter, RefNumberFilterPaycheck, RefNumberRangeFilterPaycheck, TxnDateRangeFilterPaycheck } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks paycheck operations: `qube.paycheck.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Paycheck {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List paychecks: `GET /connections/{connection_id}/paychecks`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `account_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `max_returned`, `meta_data`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/paychecks/list-paychecks
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: PaycheckQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `paycheck.query`: List paychecks.
|
|
25
|
+
*/
|
|
26
|
+
export interface PaycheckQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
29
|
+
*/
|
|
30
|
+
account_filter?: AccountFilterPaycheck;
|
|
31
|
+
/**
|
|
32
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
33
|
+
*/
|
|
34
|
+
entity_filter?: AccountFilterPaycheck;
|
|
35
|
+
include_line_items?: boolean;
|
|
36
|
+
include_ret_element?: Array<"AccountRef" | "Address" | "Amount" | "ClassRef" | "EditSequence" | "EmployeeRef" | "IsAccruingTime" | "IsToBePrinted" | "Memo" | "PayPeriodBeginDate" | "PayPeriodEndDate" | "PaycheckLineRet" | "PayrollDate" | "RefNumber" | "SickHoursAccrued" | "SickHoursAvailable" | "TaxTableVersion" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber" | "VacationHoursAccrued" | "VacationHoursAvailable">;
|
|
37
|
+
/**
|
|
38
|
+
* QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
|
|
39
|
+
*
|
|
40
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
41
|
+
*
|
|
42
|
+
* Minimum 1.
|
|
43
|
+
*/
|
|
44
|
+
max_returned?: number;
|
|
45
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
46
|
+
/**
|
|
47
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
48
|
+
*/
|
|
49
|
+
modified_date_range_filter?: ModifiedDateRangeFilterPaycheck;
|
|
50
|
+
/**
|
|
51
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
52
|
+
*/
|
|
53
|
+
payroll_date_range_filter?: PayrollDateRangeFilter;
|
|
54
|
+
/**
|
|
55
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
56
|
+
*/
|
|
57
|
+
ref_number?: string[];
|
|
58
|
+
/**
|
|
59
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
60
|
+
*/
|
|
61
|
+
ref_number_case_sensitive?: string[];
|
|
62
|
+
/**
|
|
63
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
64
|
+
*/
|
|
65
|
+
ref_number_filter?: RefNumberFilterPaycheck;
|
|
66
|
+
/**
|
|
67
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
68
|
+
*/
|
|
69
|
+
ref_number_range_filter?: RefNumberRangeFilterPaycheck;
|
|
70
|
+
/**
|
|
71
|
+
* 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`.
|
|
72
|
+
*/
|
|
73
|
+
request_id?: string;
|
|
74
|
+
/**
|
|
75
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
76
|
+
*/
|
|
77
|
+
txn_date_range_filter?: TxnDateRangeFilterPaycheck;
|
|
78
|
+
/**
|
|
79
|
+
* 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`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
80
|
+
*/
|
|
81
|
+
txn_id?: string[];
|
|
82
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks paycheck operations. Types: paycheck.d.ts. */
|
|
5
|
+
class Paycheck {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List paychecks.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./paycheck").PaycheckQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/paychecks/list-paychecks
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("paycheck.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { Paycheck };
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, NameFilter, NameRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks payment method operations: `qube.paymentMethod.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class PaymentMethod {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create payment method: `POST /connections/{connection_id}/payment-methods`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `include_ret_element`, `is_active`, `name` (required), `payment_method_type`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/payment-methods/create-payment-method
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: PaymentMethodCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List payment methods: `GET /connections/{connection_id}/payment-methods`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `payment_method_type`, `request_id`, `to_modified_date`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/payment-methods/list-payment-methods
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: PaymentMethodQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `payment_method.create`: Create payment method.
|
|
37
|
+
*/
|
|
38
|
+
export interface PaymentMethodCreateParams {
|
|
39
|
+
include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "IsActive" | "ListID" | "Name" | "OwnerID" | "PaymentMethodType" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
40
|
+
/**
|
|
41
|
+
* If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
|
42
|
+
*/
|
|
43
|
+
is_active?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* 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 FullName remains distinct.
|
|
46
|
+
*/
|
|
47
|
+
name: string;
|
|
48
|
+
/**
|
|
49
|
+
* The payment method, such as check, cash, debit card, Visa, etc.
|
|
50
|
+
*/
|
|
51
|
+
payment_method_type?: "AmericanExpress" | "Cash" | "Check" | "DebitCard" | "Discover" | "ECheck" | "GiftCard" | "MasterCard" | "Other" | "OtherCreditCard" | "Visa";
|
|
52
|
+
/**
|
|
53
|
+
* 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`.
|
|
54
|
+
*/
|
|
55
|
+
request_id?: string;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* The params of `payment_method.query`: List payment methods.
|
|
60
|
+
*/
|
|
61
|
+
export interface PaymentMethodQueryParams {
|
|
62
|
+
/**
|
|
63
|
+
* 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.
|
|
64
|
+
*
|
|
65
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
66
|
+
*/
|
|
67
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
68
|
+
/**
|
|
69
|
+
* 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.
|
|
70
|
+
*
|
|
71
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
72
|
+
*
|
|
73
|
+
* Format: date-time.
|
|
74
|
+
*/
|
|
75
|
+
from_modified_date?: string;
|
|
76
|
+
/**
|
|
77
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
78
|
+
*/
|
|
79
|
+
full_name?: string[];
|
|
80
|
+
include_ret_element?: Array<"EditSequence" | "IsActive" | "ListID" | "Name" | "PaymentMethodType" | "TimeCreated" | "TimeModified">;
|
|
81
|
+
/**
|
|
82
|
+
* `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`.
|
|
83
|
+
*
|
|
84
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
85
|
+
*/
|
|
86
|
+
list_id?: string[];
|
|
87
|
+
/**
|
|
88
|
+
* 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.
|
|
89
|
+
*
|
|
90
|
+
* QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
|
|
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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
93
|
+
*
|
|
94
|
+
* Minimum 1.
|
|
95
|
+
*/
|
|
96
|
+
max_returned?: number;
|
|
97
|
+
/**
|
|
98
|
+
* 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.
|
|
99
|
+
*/
|
|
100
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
101
|
+
/**
|
|
102
|
+
* Filters according to the object’s Name.
|
|
103
|
+
*
|
|
104
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
105
|
+
*/
|
|
106
|
+
name_filter?: NameFilter;
|
|
107
|
+
/**
|
|
108
|
+
* Filters according to the object’s Name.
|
|
109
|
+
*
|
|
110
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
111
|
+
*/
|
|
112
|
+
name_range_filter?: NameRangeFilter;
|
|
113
|
+
/**
|
|
114
|
+
* The payment method, such as check, cash, debit card, Visa, etc.
|
|
115
|
+
*
|
|
116
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
117
|
+
*/
|
|
118
|
+
payment_method_type?: Array<"AmericanExpress" | "Cash" | "Check" | "DebitCard" | "Discover" | "ECheck" | "GiftCard" | "MasterCard" | "Other" | "OtherCreditCard" | "Visa">;
|
|
119
|
+
/**
|
|
120
|
+
* 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`.
|
|
121
|
+
*/
|
|
122
|
+
request_id?: string;
|
|
123
|
+
/**
|
|
124
|
+
* 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).
|
|
125
|
+
*
|
|
126
|
+
* 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`, `payment_method_type`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
127
|
+
*
|
|
128
|
+
* Format: date-time.
|
|
129
|
+
*/
|
|
130
|
+
to_modified_date?: string;
|
|
131
|
+
}
|