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,100 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, ReportAccountFilter, ReportClassFilter, ReportEntityFilter, ReportItemFilter, ReportModifiedDateRangeFilter, ReportPeriod, ReportTxnTypeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks aging report operations: `qube.agingReport.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class AgingReport {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List aging reports: `GET /connections/{connection_id}/aging-reports`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `aging_report_type` (required), `display_report`, `include_accounts`, `include_column`, `report_account_filter`, `report_aging_as_of`, `report_class_filter`, `report_date_macro`, `report_detail_level_filter`, `report_entity_filter`, `report_item_filter`, `report_modified_date_range_filter`, `report_modified_date_range_macro`, `report_period`, `report_posting_status_filter`, `report_txn_type_filter`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/aging-reports/list-aging-reports
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: AgingReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `aging_report.query`: List aging reports.
|
|
25
|
+
*/
|
|
26
|
+
export interface AgingReportQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* The type of aging report being queried.
|
|
29
|
+
*/
|
|
30
|
+
aging_report_type: "APAgingDetail" | "APAgingSummary" | "ARAgingDetail" | "ARAgingSummary" | "CollectionsReport";
|
|
31
|
+
/**
|
|
32
|
+
* Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
|
|
33
|
+
*/
|
|
34
|
+
display_report?: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Indicates whether this report should include all accounts or just those that are currently in use.
|
|
37
|
+
*/
|
|
38
|
+
include_accounts?: "All" | "InUse";
|
|
39
|
+
include_column?: Array<"Account" | "Aging" | "Amount" | "AmountDifference" | "AverageCost" | "BilledDate" | "BillingStatus" | "CalculatedAmount" | "Class" | "ClearedStatus" | "CostPrice" | "Credit" | "Currency" | "Date" | "Debit" | "DeliveryDate" | "DueDate" | "EstimateActive" | "ExchangeRate" | "FOB" | "IncomeSubjectToTax" | "Invoiced" | "Item" | "ItemDesc" | "LastModifiedBy" | "LatestOrPriorState" | "Memo" | "ModifiedTime" | "Name" | "NameAccountNumber" | "NameAddress" | "NameCity" | "NameContact" | "NameEmail" | "NameFax" | "NamePhone" | "NameState" | "NameZip" | "OpenBalance" | "OriginalAmount" | "PONumber" | "PaidAmount" | "PaidStatus" | "PaidThroughDate" | "PaymentMethod" | "PayrollItem" | "PrintStatus" | "ProgressAmount" | "ProgressPercent" | "Quantity" | "QuantityAvailable" | "QuantityOnHand" | "QuantityOnSalesOrder" | "ReceivedQuantity" | "RefNumber" | "RunningBalance" | "SSNOrTaxID" | "SalesRep" | "SalesTaxCode" | "SerialOrLotNumber" | "ShipDate" | "ShipMethod" | "SourceName" | "SplitAccount" | "TaxLine" | "TaxTableVersion" | "Terms" | "TxnID" | "TxnNumber" | "TxnType" | "UnitPrice" | "UserEdit" | "ValueOnHand" | "WageBase" | "WageBaseTips">;
|
|
40
|
+
/**
|
|
41
|
+
* Allows you to query for a specified account type or for specific list elements.
|
|
42
|
+
*/
|
|
43
|
+
report_account_filter?: ReportAccountFilter;
|
|
44
|
+
/**
|
|
45
|
+
* The report will return aging information up to the `report_aging_as_of` date.
|
|
46
|
+
*/
|
|
47
|
+
report_aging_as_of?: "ReportEndDate" | "Today";
|
|
48
|
+
/**
|
|
49
|
+
* Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
50
|
+
*/
|
|
51
|
+
report_class_filter?: ReportClassFilter;
|
|
52
|
+
/**
|
|
53
|
+
* The time period covered by this report.
|
|
54
|
+
*
|
|
55
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
56
|
+
*/
|
|
57
|
+
report_date_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
|
|
58
|
+
/**
|
|
59
|
+
* The level of detail to include in the report.
|
|
60
|
+
*/
|
|
61
|
+
report_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
|
|
62
|
+
/**
|
|
63
|
+
* Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
|
|
64
|
+
*/
|
|
65
|
+
report_entity_filter?: ReportEntityFilter;
|
|
66
|
+
/**
|
|
67
|
+
* Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
|
|
68
|
+
*/
|
|
69
|
+
report_item_filter?: ReportItemFilter;
|
|
70
|
+
/**
|
|
71
|
+
* Returns reports that were modified between these two dates (inclusive). The range of acceptable dates for both `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
|
|
72
|
+
*
|
|
73
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
74
|
+
*/
|
|
75
|
+
report_modified_date_range_filter?: ReportModifiedDateRangeFilter;
|
|
76
|
+
/**
|
|
77
|
+
* The time period covered by this report.
|
|
78
|
+
*
|
|
79
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
80
|
+
*/
|
|
81
|
+
report_modified_date_range_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
|
|
82
|
+
/**
|
|
83
|
+
* If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
|
|
84
|
+
*
|
|
85
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
86
|
+
*/
|
|
87
|
+
report_period?: ReportPeriod;
|
|
88
|
+
/**
|
|
89
|
+
* Allows you to query for posting reports, non-posting reports, or reports that are either one.
|
|
90
|
+
*/
|
|
91
|
+
report_posting_status_filter?: "Either" | "NonPosting" | "Posting";
|
|
92
|
+
/**
|
|
93
|
+
* Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
|
|
94
|
+
*/
|
|
95
|
+
report_txn_type_filter?: ReportTxnTypeFilter;
|
|
96
|
+
/**
|
|
97
|
+
* 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`.
|
|
98
|
+
*/
|
|
99
|
+
request_id?: string;
|
|
100
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks aging report operations. Types: aging_report.d.ts. */
|
|
5
|
+
class AgingReport {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List aging reports.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./aging_report").AgingReportQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/aging-reports/list-aging-reports
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("aging_report.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { AgingReport };
|
|
@@ -0,0 +1,118 @@
|
|
|
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 alert operations: `qube.alert.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Alert {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create alert: `POST /connections/{connection_id}/alerts`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `activation_date`, `alert_permission`, `alert_tag` (required), `com_callback_info`, `desc` (required), `expiration_date`, `help_text` (required), `http_callback_info`, `message_text` (required), `owner_id` (required), `request_id`, `ui_context`.
|
|
16
|
+
*
|
|
17
|
+
* Give exactly one of: `com_callback_info`, or `http_callback_info`.
|
|
18
|
+
*
|
|
19
|
+
* Resolves to the queued request.
|
|
20
|
+
* @see https://docs.qubesync.com/api-reference/v2/alerts/create-alert
|
|
21
|
+
*/
|
|
22
|
+
create(connectionId: string, params: AlertCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
23
|
+
/**
|
|
24
|
+
* Delete alert: `DELETE /connections/{connection_id}/alerts`, queued for QuickBooks.
|
|
25
|
+
*
|
|
26
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
27
|
+
* Params go in the JSON body.
|
|
28
|
+
*
|
|
29
|
+
* Fields: `alert_tag` (required), `owner_id` (required), `request_id`.
|
|
30
|
+
*
|
|
31
|
+
* Resolves to the queued request.
|
|
32
|
+
* @see https://docs.qubesync.com/api-reference/v2/alerts/delete-alert
|
|
33
|
+
*/
|
|
34
|
+
delete(connectionId: string, params: AlertDeleteParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
35
|
+
/**
|
|
36
|
+
* List alerts: `GET /connections/{connection_id}/alerts`, queued for QuickBooks.
|
|
37
|
+
*
|
|
38
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
39
|
+
* Params go in the query string.
|
|
40
|
+
*
|
|
41
|
+
* Fields: `meta_data`, `owner_id` (required), `request_id`.
|
|
42
|
+
*
|
|
43
|
+
* Resolves to the queued request.
|
|
44
|
+
* @see https://docs.qubesync.com/api-reference/v2/alerts/list-alerts
|
|
45
|
+
*/
|
|
46
|
+
query(connectionId: string, params: AlertQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* The params of `alert.create`: Create alert.
|
|
51
|
+
*
|
|
52
|
+
* Give exactly one of: `com_callback_info`, or `http_callback_info`.
|
|
53
|
+
*/
|
|
54
|
+
export interface AlertCreateParams {
|
|
55
|
+
/**
|
|
56
|
+
* Format: date.
|
|
57
|
+
*/
|
|
58
|
+
activation_date?: string;
|
|
59
|
+
alert_permission?: AlertPermission;
|
|
60
|
+
alert_tag: string;
|
|
61
|
+
com_callback_info?: ComCallbackInfo;
|
|
62
|
+
desc: string;
|
|
63
|
+
/**
|
|
64
|
+
* Format: date.
|
|
65
|
+
*/
|
|
66
|
+
expiration_date?: string;
|
|
67
|
+
help_text: string;
|
|
68
|
+
http_callback_info?: HttpCallbackInfo;
|
|
69
|
+
message_text: string;
|
|
70
|
+
owner_id: string;
|
|
71
|
+
/**
|
|
72
|
+
* 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`.
|
|
73
|
+
*/
|
|
74
|
+
request_id?: string;
|
|
75
|
+
ui_context?: Array<"AlertsManager" | "CompanyNavigator">;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* The params of `alert.delete`: Delete alert.
|
|
80
|
+
*/
|
|
81
|
+
export interface AlertDeleteParams {
|
|
82
|
+
alert_tag: string;
|
|
83
|
+
owner_id: string;
|
|
84
|
+
/**
|
|
85
|
+
* 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`.
|
|
86
|
+
*/
|
|
87
|
+
request_id?: string;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* The params of `alert.query`: List alerts.
|
|
92
|
+
*/
|
|
93
|
+
export interface AlertQueryParams {
|
|
94
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
95
|
+
owner_id: string[];
|
|
96
|
+
/**
|
|
97
|
+
* 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`.
|
|
98
|
+
*/
|
|
99
|
+
request_id?: string;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export interface AlertPermission {
|
|
103
|
+
permission_level: Array<"AccountsPayable" | "AccountsReceivable" | "Banking" | "Finance" | "Inventory" | "TimeTracking">;
|
|
104
|
+
permission_needed: "All" | "Any";
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Give exactly one of: `prog_id`, or `clsid`.
|
|
109
|
+
*/
|
|
110
|
+
export interface ComCallbackInfo {
|
|
111
|
+
app_name: string;
|
|
112
|
+
clsid?: string;
|
|
113
|
+
prog_id?: string;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export interface HttpCallbackInfo {
|
|
117
|
+
url: string;
|
|
118
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks alert operations. Types: alert.d.ts. */
|
|
5
|
+
class Alert {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create alert.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./alert").AlertCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/alerts/create-alert
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("alert.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Delete alert.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./alert").AlertDeleteParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/alerts/delete-alert
|
|
32
|
+
*/
|
|
33
|
+
delete(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("alert.delete", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* List alerts.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./alert").AlertQueryParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/alerts/list-alerts
|
|
44
|
+
*/
|
|
45
|
+
query(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("alert.query", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { Alert };
|
|
@@ -0,0 +1,201 @@
|
|
|
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, CreditCardTxnInfo, CurrencyFilter, CurrencyRef, ModifiedDateRangeFilter, RefNumberFilter, RefNumberRangeFilter, TxnDateRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks ar refund credit card operations: `qube.arRefundCreditCard.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ArRefundCreditCard {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create ar refund credit card: `POST /connections/{connection_id}/ar-refund-credit-cards`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `address`, `ar_account_ref`, `credit_card_txn_info`, `customer_ref` (required), `def_macro`, `exchange_rate`, `external_guid`, `include_ret_element`, `memo`, `payment_method_ref`, `ref_number`, `refund_applied_to_txn_add` (required), `refund_from_account_ref`, `request_id`, `txn_date`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/ar-refund-credit-cards/create-ar-refund-credit-card
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ArRefundCreditCardCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List ar refund credit cards: `GET /connections/{connection_id}/ar-refund-credit-cards`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `account_filter`, `currency_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `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`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/ar-refund-credit-cards/list-ar-refund-credit-cards
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: ArRefundCreditCardQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `ar_refund_credit_card.create`: Create ar refund credit card.
|
|
37
|
+
*/
|
|
38
|
+
export interface ArRefundCreditCardCreateParams {
|
|
39
|
+
/**
|
|
40
|
+
* 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.
|
|
41
|
+
*/
|
|
42
|
+
address?: Address;
|
|
43
|
+
/**
|
|
44
|
+
* `ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
45
|
+
*/
|
|
46
|
+
ar_account_ref?: CurrencyRef;
|
|
47
|
+
/**
|
|
48
|
+
* Contains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction. The data following the element `credit_card_txn_input_info`” data is the data from the original qbmsXML request. The “`credit_card_txn_result_info`” is the data from the original qbmsXML response.
|
|
49
|
+
*/
|
|
50
|
+
credit_card_txn_info?: CreditCardTxnInfo;
|
|
51
|
+
/**
|
|
52
|
+
* `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
|
|
53
|
+
*/
|
|
54
|
+
customer_ref: CurrencyRef;
|
|
55
|
+
/**
|
|
56
|
+
* `def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
|
|
57
|
+
*/
|
|
58
|
+
def_macro?: string;
|
|
59
|
+
/**
|
|
60
|
+
* `exchange_rate` is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK. If your home currency is USD and internet access is available, rates can be downloaded in the QuickBooks UI via Lists > Currency > Activities > Download Latest Exchange Rates.
|
|
61
|
+
*/
|
|
62
|
+
exchange_rate?: number;
|
|
63
|
+
/**
|
|
64
|
+
* Allows for the attachment of a user defined GUID value.
|
|
65
|
+
*/
|
|
66
|
+
external_guid?: string;
|
|
67
|
+
include_ret_element?: Array<"ARAccountRef" | "Address" | "AddressBlock" | "CreditCardTxnInfo" | "CurrencyRef" | "CustomerRef" | "DataExtRet" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "ListID" | "Memo" | "OwnerID" | "PaymentMethodRef" | "RefNumber" | "RefundAppliedToTxnRet" | "RefundFromAccountRef" | "TimeCreated" | "TimeModified" | "TotalAmount" | "TotalAmountInHomeCurrency" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
68
|
+
/**
|
|
69
|
+
* Additional information.
|
|
70
|
+
*/
|
|
71
|
+
memo?: string;
|
|
72
|
+
/**
|
|
73
|
+
* `payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
74
|
+
*/
|
|
75
|
+
payment_method_ref?: CurrencyRef;
|
|
76
|
+
/**
|
|
77
|
+
* `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.
|
|
78
|
+
*/
|
|
79
|
+
ref_number?: string;
|
|
80
|
+
refund_applied_to_txn_add: RefundAppliedToTxnAdd[];
|
|
81
|
+
/**
|
|
82
|
+
* In an ARRefundCreditCardAdd, the account which is the source of funds for the credit card refund. Normally this is Undeposited Funds. However, you can specify another account if you wish. If you specify nothing here, Undeposited Funds is used by default.
|
|
83
|
+
*/
|
|
84
|
+
refund_from_account_ref?: CurrencyRef;
|
|
85
|
+
/**
|
|
86
|
+
* 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`.
|
|
87
|
+
*/
|
|
88
|
+
request_id?: string;
|
|
89
|
+
/**
|
|
90
|
+
* 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.
|
|
91
|
+
*
|
|
92
|
+
* Format: date.
|
|
93
|
+
*/
|
|
94
|
+
txn_date?: string;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* The params of `ar_refund_credit_card.query`: List ar refund credit cards.
|
|
99
|
+
*/
|
|
100
|
+
export interface ArRefundCreditCardQueryParams {
|
|
101
|
+
/**
|
|
102
|
+
* 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.
|
|
103
|
+
*
|
|
104
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
105
|
+
*/
|
|
106
|
+
account_filter?: AccountFilter;
|
|
107
|
+
/**
|
|
108
|
+
* Filters by the specified currency.
|
|
109
|
+
*
|
|
110
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
111
|
+
*/
|
|
112
|
+
currency_filter?: CurrencyFilter;
|
|
113
|
+
/**
|
|
114
|
+
* 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.
|
|
115
|
+
*
|
|
116
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
117
|
+
*/
|
|
118
|
+
entity_filter?: AccountFilter;
|
|
119
|
+
/**
|
|
120
|
+
* 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.
|
|
121
|
+
*/
|
|
122
|
+
include_line_items?: boolean;
|
|
123
|
+
include_ret_element?: Array<"ARAccountRef" | "Address" | "AddressBlock" | "CreditCardTxnInfo" | "CurrencyRef" | "CustomerRef" | "DataExtRet" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "Memo" | "PaymentMethodRef" | "RefNumber" | "RefundAppliedToTxnRet" | "RefundFromAccountRef" | "TimeCreated" | "TimeModified" | "TotalAmount" | "TotalAmountInHomeCurrency" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
124
|
+
/**
|
|
125
|
+
* 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.
|
|
126
|
+
*/
|
|
127
|
+
iterator?: boolean;
|
|
128
|
+
/**
|
|
129
|
+
* 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.
|
|
130
|
+
*
|
|
131
|
+
* 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.
|
|
132
|
+
*
|
|
133
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
134
|
+
*
|
|
135
|
+
* Minimum 1.
|
|
136
|
+
*/
|
|
137
|
+
max_returned?: number;
|
|
138
|
+
/**
|
|
139
|
+
* 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.
|
|
140
|
+
*/
|
|
141
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
142
|
+
/**
|
|
143
|
+
* 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.
|
|
144
|
+
*
|
|
145
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
146
|
+
*/
|
|
147
|
+
modified_date_range_filter?: ModifiedDateRangeFilter;
|
|
148
|
+
/**
|
|
149
|
+
* `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.
|
|
150
|
+
*/
|
|
151
|
+
owner_id?: string[];
|
|
152
|
+
/**
|
|
153
|
+
* `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.
|
|
154
|
+
*
|
|
155
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
156
|
+
*/
|
|
157
|
+
ref_number?: string[];
|
|
158
|
+
/**
|
|
159
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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_case_sensitive?: string[];
|
|
162
|
+
/**
|
|
163
|
+
* Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
|
|
164
|
+
*
|
|
165
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
166
|
+
*/
|
|
167
|
+
ref_number_filter?: RefNumberFilter;
|
|
168
|
+
/**
|
|
169
|
+
* Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
|
|
170
|
+
*
|
|
171
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
172
|
+
*/
|
|
173
|
+
ref_number_range_filter?: RefNumberRangeFilter;
|
|
174
|
+
/**
|
|
175
|
+
* 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`.
|
|
176
|
+
*/
|
|
177
|
+
request_id?: string;
|
|
178
|
+
/**
|
|
179
|
+
* Filters according to the original transaction dates.
|
|
180
|
+
*
|
|
181
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
182
|
+
*/
|
|
183
|
+
txn_date_range_filter?: TxnDateRangeFilter;
|
|
184
|
+
/**
|
|
185
|
+
* `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.
|
|
186
|
+
*
|
|
187
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`, `entity_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.
|
|
188
|
+
*/
|
|
189
|
+
txn_id?: string[];
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
export interface RefundAppliedToTxnAdd {
|
|
193
|
+
/**
|
|
194
|
+
* Specifies the amount to be taken from the credit transaction you are linking via this aggregate. The amount specified in this aggregate can’t exceed the amount of the credit transaction you are linking. If you supply an amount that exceeds, you’ll get a runtime error.
|
|
195
|
+
*/
|
|
196
|
+
refund_amount: number;
|
|
197
|
+
/**
|
|
198
|
+
* `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.
|
|
199
|
+
*/
|
|
200
|
+
txn_id: string;
|
|
201
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks ar refund credit card operations. Types: ar_refund_credit_card.d.ts. */
|
|
5
|
+
class ArRefundCreditCard {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create ar refund credit card.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./ar_refund_credit_card").ArRefundCreditCardCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/ar-refund-credit-cards/create-ar-refund-credit-card
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("ar_refund_credit_card.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List ar refund credit cards (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./ar_refund_credit_card").ArRefundCreditCardQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/ar-refund-credit-cards/list-ar-refund-credit-cards
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("ar_refund_credit_card.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
module.exports = { ArRefundCreditCard };
|
|
@@ -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 } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks bar code operations: `qube.barCode.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class BarCode {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List bar codes: `GET /connections/{connection_id}/bar-codes`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `bar_code_value`, `iterator`, `meta_data`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/bar-codes/list-bar-codes
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: BarCodeQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `bar_code.query`: List bar codes.
|
|
25
|
+
*/
|
|
26
|
+
export interface BarCodeQueryParams {
|
|
27
|
+
bar_code_value?: string[];
|
|
28
|
+
/**
|
|
29
|
+
* Page through every result: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`.
|
|
30
|
+
*/
|
|
31
|
+
iterator?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* 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.
|
|
34
|
+
*/
|
|
35
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
36
|
+
/**
|
|
37
|
+
* 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`.
|
|
38
|
+
*/
|
|
39
|
+
request_id?: string;
|
|
40
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks bar code operations. Types: bar_code.d.ts. */
|
|
5
|
+
class BarCode {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List bar codes.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./bar_code").BarCodeQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/bar-codes/list-bar-codes
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("bar_code.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { BarCode };
|