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,254 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AccountFilter, Address, CurrencyRef, ModifiedDateRangeFilter, RefNumberFilter, RefNumberRangeFilter, TxnDateRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks sales tax payment check operations: `qube.salesTaxPaymentCheck.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class SalesTaxPaymentCheck {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create sales tax payment check: `POST /connections/{connection_id}/sales-tax-payment-checks`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `address`, `bank_account_ref` (required), `def_macro`, `external_guid`, `include_ret_element`, `is_to_be_printed`, `memo`, `payee_entity_ref` (required), `ref_number`, `request_id`, `sales_tax_payment_check_line_add` (required), `txn_date` (required).
|
|
16
|
+
*
|
|
17
|
+
* Give exactly one of: `is_to_be_printed`, or `ref_number`.
|
|
18
|
+
*
|
|
19
|
+
* Resolves to the queued request.
|
|
20
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-payment-checks/create-sales-tax-payment-check
|
|
21
|
+
*/
|
|
22
|
+
create(connectionId: string, params: SalesTaxPaymentCheckCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
23
|
+
/**
|
|
24
|
+
* List sales tax payment checks: `GET /connections/{connection_id}/sales-tax-payment-checks`, queued for QuickBooks.
|
|
25
|
+
*
|
|
26
|
+
* QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
|
|
27
|
+
* Params go in the query string.
|
|
28
|
+
*
|
|
29
|
+
* Fields: `account_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `item_filter`, `iterator`, `max_returned`, `meta_data`, `modified_date_range_filter`, `owner_id`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
|
|
30
|
+
*
|
|
31
|
+
* Resolves to the queued request.
|
|
32
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-payment-checks/list-sales-tax-payment-checks
|
|
33
|
+
*/
|
|
34
|
+
query(connectionId: string, params: SalesTaxPaymentCheckQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
35
|
+
/**
|
|
36
|
+
* Update sales tax payment check: `PUT /connections/{connection_id}/sales-tax-payment-checks`, queued for QuickBooks.
|
|
37
|
+
*
|
|
38
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
39
|
+
* Params go in the JSON body.
|
|
40
|
+
*
|
|
41
|
+
* Fields: `address`, `bank_account_ref`, `edit_sequence` (required), `include_ret_element`, `is_to_be_printed`, `memo`, `ref_number`, `request_id`, `txn_date`, `txn_id` (required).
|
|
42
|
+
*
|
|
43
|
+
* Resolves to the queued request.
|
|
44
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-payment-checks/update-sales-tax-payment-check
|
|
45
|
+
*/
|
|
46
|
+
update(connectionId: string, params: SalesTaxPaymentCheckUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* The params of `sales_tax_payment_check.create`: Create sales tax payment check.
|
|
51
|
+
*
|
|
52
|
+
* Give exactly one of: `is_to_be_printed`, or `ref_number`.
|
|
53
|
+
*/
|
|
54
|
+
export interface SalesTaxPaymentCheckCreateParams {
|
|
55
|
+
/**
|
|
56
|
+
* If an address request fails, some combination of address fields might be too long. In a Check, BillPaymentCheck, or SalesTaxPaymentCheck message, Address is the address that will print on the check.
|
|
57
|
+
*/
|
|
58
|
+
address?: Address;
|
|
59
|
+
/**
|
|
60
|
+
* Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `bank_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
61
|
+
*/
|
|
62
|
+
bank_account_ref: CurrencyRef;
|
|
63
|
+
/**
|
|
64
|
+
* `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
|
|
65
|
+
*/
|
|
66
|
+
def_macro?: string;
|
|
67
|
+
/**
|
|
68
|
+
* Allows for the attachment of a user defined GUID value.
|
|
69
|
+
*/
|
|
70
|
+
external_guid?: string;
|
|
71
|
+
include_ret_element?: Array<"Address" | "AddressBlock" | "Amount" | "BankAccountRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsToBePrinted" | "ListID" | "Memo" | "OwnerID" | "PayeeEntityRef" | "RefNumber" | "SalesTaxPaymentCheckLineRet" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
72
|
+
/**
|
|
73
|
+
* If `is_to_be_printed` is true, QuickBooks queues the form for later printing. It does not print immediately; printing is still a user action in QuickBooks.
|
|
74
|
+
*/
|
|
75
|
+
is_to_be_printed?: boolean;
|
|
76
|
+
/**
|
|
77
|
+
* Additional information.
|
|
78
|
+
*/
|
|
79
|
+
memo?: string;
|
|
80
|
+
/**
|
|
81
|
+
* `payee_entity_ref` identifies the payee (customer, vendor, employee, or Other Name). If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
82
|
+
*/
|
|
83
|
+
payee_entity_ref: CurrencyRef;
|
|
84
|
+
/**
|
|
85
|
+
* `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
|
|
86
|
+
*/
|
|
87
|
+
ref_number?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
|
|
90
|
+
*/
|
|
91
|
+
request_id?: string;
|
|
92
|
+
sales_tax_payment_check_line_add: SalesTaxPaymentCheckLineAdd[];
|
|
93
|
+
/**
|
|
94
|
+
* The date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
|
|
95
|
+
*
|
|
96
|
+
* Format: date.
|
|
97
|
+
*/
|
|
98
|
+
txn_date: string;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* The params of `sales_tax_payment_check.query`: List sales tax payment checks.
|
|
103
|
+
*/
|
|
104
|
+
export interface SalesTaxPaymentCheckQueryParams {
|
|
105
|
+
/**
|
|
106
|
+
* Filters according to the account name or `list_id`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `full_name` and get the account you’re looking for. But if numbers have been used as account names, confusion could arise.
|
|
107
|
+
*
|
|
108
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
109
|
+
*/
|
|
110
|
+
account_filter?: AccountFilter;
|
|
111
|
+
/**
|
|
112
|
+
* An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an EntityQuery request to get information about all the entities that are set up in the QuickBooks file. In an ARRefundCreditCard query, this must be a customer/customer job.
|
|
113
|
+
*
|
|
114
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
115
|
+
*/
|
|
116
|
+
entity_filter?: AccountFilter;
|
|
117
|
+
/**
|
|
118
|
+
* This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set `include_line_items` to true to include line items in the response if you don’t mind getting a larger result.
|
|
119
|
+
*/
|
|
120
|
+
include_line_items?: boolean;
|
|
121
|
+
include_ret_element?: Array<"Address" | "AddressBlock" | "Amount" | "BankAccountRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsToBePrinted" | "Memo" | "PayeeEntityRef" | "RefNumber" | "SalesTaxPaymentCheckLineRet" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
122
|
+
/**
|
|
123
|
+
* Filters according to the item name or ID. You can use an ItemQuery request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items.
|
|
124
|
+
*
|
|
125
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
126
|
+
*/
|
|
127
|
+
item_filter?: AccountFilter;
|
|
128
|
+
/**
|
|
129
|
+
* Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records (25 with `include_line_items`); send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `ref_number`, `ref_number_case_sensitive` or `txn_id` every match comes back in one answer, so leave `iterator` out.
|
|
130
|
+
*/
|
|
131
|
+
iterator?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* 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.
|
|
134
|
+
*
|
|
135
|
+
* The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched.
|
|
136
|
+
*
|
|
137
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
138
|
+
*
|
|
139
|
+
* Minimum 1.
|
|
140
|
+
*/
|
|
141
|
+
max_returned?: number;
|
|
142
|
+
/**
|
|
143
|
+
* 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.
|
|
144
|
+
*/
|
|
145
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
146
|
+
/**
|
|
147
|
+
* Filters according to the dates when transactions were last modified. The `modified_date_range_filter` aggregate isn’t required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `from_modified_date` and `to_modified_date` fields wasn’t supported in qbXML version 1.0 or 1.1.
|
|
148
|
+
*
|
|
149
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
150
|
+
*/
|
|
151
|
+
modified_date_range_filter?: ModifiedDateRangeFilter;
|
|
152
|
+
/**
|
|
153
|
+
* `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.
|
|
154
|
+
*/
|
|
155
|
+
owner_id?: string[];
|
|
156
|
+
/**
|
|
157
|
+
* `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
|
|
158
|
+
*
|
|
159
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
160
|
+
*/
|
|
161
|
+
ref_number?: string[];
|
|
162
|
+
/**
|
|
163
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
164
|
+
*/
|
|
165
|
+
ref_number_case_sensitive?: string[];
|
|
166
|
+
/**
|
|
167
|
+
* Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
|
|
168
|
+
*
|
|
169
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
170
|
+
*/
|
|
171
|
+
ref_number_filter?: RefNumberFilter;
|
|
172
|
+
/**
|
|
173
|
+
* Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
|
|
174
|
+
*
|
|
175
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
176
|
+
*/
|
|
177
|
+
ref_number_range_filter?: RefNumberRangeFilter;
|
|
178
|
+
/**
|
|
179
|
+
* 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`.
|
|
180
|
+
*/
|
|
181
|
+
request_id?: string;
|
|
182
|
+
/**
|
|
183
|
+
* Filters according to the original transaction dates.
|
|
184
|
+
*
|
|
185
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
186
|
+
*/
|
|
187
|
+
txn_date_range_filter?: TxnDateRangeFilter;
|
|
188
|
+
/**
|
|
189
|
+
* `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
|
|
190
|
+
*
|
|
191
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `item_filter`, `max_returned`, `modified_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.
|
|
192
|
+
*/
|
|
193
|
+
txn_id?: string[];
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* The params of `sales_tax_payment_check.update`: Update sales tax payment check.
|
|
198
|
+
*/
|
|
199
|
+
export interface SalesTaxPaymentCheckUpdateParams {
|
|
200
|
+
/**
|
|
201
|
+
* If an address request fails, some combination of address fields might be too long. In a Check, BillPaymentCheck, or SalesTaxPaymentCheck message, Address is the address that will print on the check.
|
|
202
|
+
*/
|
|
203
|
+
address?: Address;
|
|
204
|
+
/**
|
|
205
|
+
* Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `bank_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
|
|
206
|
+
*/
|
|
207
|
+
bank_account_ref?: CurrencyRef;
|
|
208
|
+
/**
|
|
209
|
+
* `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.
|
|
210
|
+
*/
|
|
211
|
+
edit_sequence: string;
|
|
212
|
+
include_ret_element?: Array<"Address" | "AddressBlock" | "Amount" | "BankAccountRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "IsToBePrinted" | "ListID" | "Memo" | "OwnerID" | "PayeeEntityRef" | "RefNumber" | "SalesTaxPaymentCheckLineRet" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
213
|
+
/**
|
|
214
|
+
* If `is_to_be_printed` is true, QuickBooks queues the form for later printing. It does not print immediately; printing is still a user action in QuickBooks.
|
|
215
|
+
*
|
|
216
|
+
* Choose at most one of: `is_to_be_printed`, or `ref_number`.
|
|
217
|
+
*/
|
|
218
|
+
is_to_be_printed?: boolean;
|
|
219
|
+
/**
|
|
220
|
+
* Additional information.
|
|
221
|
+
*/
|
|
222
|
+
memo?: string;
|
|
223
|
+
/**
|
|
224
|
+
* `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
|
|
225
|
+
*
|
|
226
|
+
* Choose at most one of: `is_to_be_printed`, or `ref_number`.
|
|
227
|
+
*/
|
|
228
|
+
ref_number?: string;
|
|
229
|
+
/**
|
|
230
|
+
* 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`.
|
|
231
|
+
*/
|
|
232
|
+
request_id?: string;
|
|
233
|
+
/**
|
|
234
|
+
* The date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
|
|
235
|
+
*
|
|
236
|
+
* Format: date.
|
|
237
|
+
*/
|
|
238
|
+
txn_date?: string;
|
|
239
|
+
/**
|
|
240
|
+
* `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
|
|
241
|
+
*/
|
|
242
|
+
txn_id: string;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
export interface SalesTaxPaymentCheckLineAdd {
|
|
246
|
+
/**
|
|
247
|
+
* A monetary amount.
|
|
248
|
+
*/
|
|
249
|
+
amount: number;
|
|
250
|
+
/**
|
|
251
|
+
* An ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead. If both `full_name` and `list_id` are provided for `item_sales_tax_ref`, `list_id` is used.
|
|
252
|
+
*/
|
|
253
|
+
item_sales_tax_ref?: CurrencyRef;
|
|
254
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks sales tax payment check operations. Types: sales_tax_payment_check.d.ts. */
|
|
5
|
+
class SalesTaxPaymentCheck {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create sales tax payment check.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./sales_tax_payment_check").SalesTaxPaymentCheckCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-payment-checks/create-sales-tax-payment-check
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("sales_tax_payment_check.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List sales tax payment checks (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./sales_tax_payment_check").SalesTaxPaymentCheckQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-payment-checks/list-sales-tax-payment-checks
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("sales_tax_payment_check.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update sales tax payment check.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./sales_tax_payment_check").SalesTaxPaymentCheckUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-payment-checks/update-sales-tax-payment-check
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("sales_tax_payment_check.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { SalesTaxPaymentCheck };
|
|
@@ -0,0 +1,35 @@
|
|
|
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 sales tax return operations: `qube.salesTaxReturn.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class SalesTaxReturn {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List sales tax returns: `GET /connections/{connection_id}/sales-tax-returns`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `meta_data`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-returns/list-sales-tax-returns
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: SalesTaxReturnQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `sales_tax_return.query`: List sales tax returns.
|
|
25
|
+
*/
|
|
26
|
+
export interface SalesTaxReturnQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* 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.
|
|
29
|
+
*/
|
|
30
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
31
|
+
/**
|
|
32
|
+
* Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
|
|
33
|
+
*/
|
|
34
|
+
request_id?: string;
|
|
35
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks sales tax return operations. Types: sales_tax_return.d.ts. */
|
|
5
|
+
class SalesTaxReturn {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List sales tax returns.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./sales_tax_return").SalesTaxReturnQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-returns/list-sales-tax-returns
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("sales_tax_return.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { SalesTaxReturn };
|
|
@@ -0,0 +1,36 @@
|
|
|
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 sales tax return line operations: `qube.salesTaxReturnLine.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class SalesTaxReturnLine {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List sales tax return lines: `GET /connections/{connection_id}/sales-tax-return-lines`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `meta_data`, `request_id`, `tax_agency_vendor_ref` (required).
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-return-lines/list-sales-tax-return-lines
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: SalesTaxReturnLineQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `sales_tax_return_line.query`: List sales tax return lines.
|
|
25
|
+
*/
|
|
26
|
+
export interface SalesTaxReturnLineQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* 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.
|
|
29
|
+
*/
|
|
30
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
31
|
+
/**
|
|
32
|
+
* Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
|
|
33
|
+
*/
|
|
34
|
+
request_id?: string;
|
|
35
|
+
tax_agency_vendor_ref: CurrencyRef[];
|
|
36
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks sales tax return line operations. Types: sales_tax_return_line.d.ts. */
|
|
5
|
+
class SalesTaxReturnLine {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List sales tax return lines.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./sales_tax_return_line").SalesTaxReturnLineQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/sales-tax-return-lines/list-sales-tax-return-lines
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("sales_tax_return_line.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { SalesTaxReturnLine };
|
|
@@ -0,0 +1,121 @@
|
|
|
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 ship method operations: `qube.shipMethod.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ShipMethod {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create ship method: `POST /connections/{connection_id}/ship-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), `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/ship-methods/create-ship-method
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ShipMethodCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List ship methods: `GET /connections/{connection_id}/ship-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`, `request_id`, `to_modified_date`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/ship-methods/list-ship-methods
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: ShipMethodQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `ship_method.create`: Create ship method.
|
|
37
|
+
*/
|
|
38
|
+
export interface ShipMethodCreateParams {
|
|
39
|
+
include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "IsActive" | "ListID" | "Name" | "OwnerID" | "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
|
+
* 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`.
|
|
50
|
+
*/
|
|
51
|
+
request_id?: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* The params of `ship_method.query`: List ship methods.
|
|
56
|
+
*/
|
|
57
|
+
export interface ShipMethodQueryParams {
|
|
58
|
+
/**
|
|
59
|
+
* 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.
|
|
60
|
+
*
|
|
61
|
+
* 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.
|
|
62
|
+
*/
|
|
63
|
+
active_status?: "ActiveOnly" | "All" | "InactiveOnly";
|
|
64
|
+
/**
|
|
65
|
+
* 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.
|
|
66
|
+
*
|
|
67
|
+
* 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.
|
|
68
|
+
*
|
|
69
|
+
* Format: date-time.
|
|
70
|
+
*/
|
|
71
|
+
from_modified_date?: string;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
*/
|
|
75
|
+
full_name?: string[];
|
|
76
|
+
include_ret_element?: Array<"EditSequence" | "IsActive" | "ListID" | "Name" | "TimeCreated" | "TimeModified">;
|
|
77
|
+
/**
|
|
78
|
+
* `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`.
|
|
79
|
+
*
|
|
80
|
+
* 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.
|
|
81
|
+
*/
|
|
82
|
+
list_id?: string[];
|
|
83
|
+
/**
|
|
84
|
+
* 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.
|
|
85
|
+
*
|
|
86
|
+
* 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.
|
|
87
|
+
*
|
|
88
|
+
* 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.
|
|
89
|
+
*
|
|
90
|
+
* Minimum 1.
|
|
91
|
+
*/
|
|
92
|
+
max_returned?: number;
|
|
93
|
+
/**
|
|
94
|
+
* 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.
|
|
95
|
+
*/
|
|
96
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
97
|
+
/**
|
|
98
|
+
* Filters according to the object’s Name.
|
|
99
|
+
*
|
|
100
|
+
* Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
101
|
+
*/
|
|
102
|
+
name_filter?: NameFilter;
|
|
103
|
+
/**
|
|
104
|
+
* Filters according to the object’s Name.
|
|
105
|
+
*
|
|
106
|
+
* 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.
|
|
107
|
+
*/
|
|
108
|
+
name_range_filter?: NameRangeFilter;
|
|
109
|
+
/**
|
|
110
|
+
* 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`.
|
|
111
|
+
*/
|
|
112
|
+
request_id?: string;
|
|
113
|
+
/**
|
|
114
|
+
* 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).
|
|
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`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
|
|
117
|
+
*
|
|
118
|
+
* Format: date-time.
|
|
119
|
+
*/
|
|
120
|
+
to_modified_date?: string;
|
|
121
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks ship method operations. Types: ship_method.d.ts. */
|
|
5
|
+
class ShipMethod {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create ship method.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./ship_method").ShipMethodCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/ship-methods/create-ship-method
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("ship_method.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List ship methods.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./ship_method").ShipMethodQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/ship-methods/list-ship-methods
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("ship_method.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
module.exports = { ShipMethod };
|
|
@@ -0,0 +1,40 @@
|
|
|
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 special account operations: `qube.specialAccount.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class SpecialAccount {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create special account: `POST /connections/{connection_id}/special-accounts`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `currency_ref`, `include_ret_element`, `request_id`, `special_account_type` (required).
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/special-accounts/create-special-account
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: SpecialAccountCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `special_account.create`: Create special account.
|
|
25
|
+
*/
|
|
26
|
+
export interface SpecialAccountCreateParams {
|
|
27
|
+
/**
|
|
28
|
+
* A currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
|
|
29
|
+
*/
|
|
30
|
+
currency_ref?: CurrencyRef;
|
|
31
|
+
include_ret_element?: Array<"AccountNumber" | "AccountType" | "Balance" | "BankNumber" | "CashFlowClassification" | "CurrencyRef" | "DataExtRet" | "Desc" | "DetailAccountType" | "EditSequence" | "ExternalGUID" | "FullName" | "IsActive" | "IsTaxAccount" | "LastCheckNumber" | "ListID" | "Name" | "OwnerID" | "ParentRef" | "SalesTaxCodeRef" | "SpecialAccountType" | "Sublevel" | "TaxLineInfoRet" | "TimeCreated" | "TimeModified" | "TotalBalance" | "TxnID" | "TxnNumber">;
|
|
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
|
+
* If `special_account_type` returns a value, then QuickBooks automatically created this account when it was needed. Some special accounts can’t be overridden, because QuickBooks uses them exclusively for special purposes.
|
|
38
|
+
*/
|
|
39
|
+
special_account_type: "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
|
|
40
|
+
}
|