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,389 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AccountFilter, CurrencyRef, ModifiedDateRangeFilter, RefNumberFilter, RefNumberRangeFilter, TxnDateRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks inventory adjustment operations: `qube.inventoryAdjustment.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class InventoryAdjustment {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create inventory adjustment: `POST /connections/{connection_id}/inventory-adjustments`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `account_ref` (required), `class_ref`, `customer_ref`, `def_macro`, `external_guid`, `include_ret_element`, `inventory_adjustment_line_add` (required), `inventory_site_ref`, `memo`, `ref_number`, `request_id`, `txn_date`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/inventory-adjustments/create-inventory-adjustment
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: InventoryAdjustmentCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List inventory adjustments: `GET /connections/{connection_id}/inventory-adjustments`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `account_filter`, `entity_filter`, `include_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`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/inventory-adjustments/list-inventory-adjustments
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: InventoryAdjustmentQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update inventory adjustment: `PUT /connections/{connection_id}/inventory-adjustments`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `account_ref`, `class_ref`, `customer_ref`, `edit_sequence` (required), `include_ret_element`, `inventory_adjustment_line_mod`, `inventory_site_ref`, `memo`, `ref_number`, `request_id`, `txn_date`, `txn_id` (required).
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/inventory-adjustments/update-inventory-adjustment
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: InventoryAdjustmentUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `inventory_adjustment.create`: Create inventory adjustment.
|
|
49
|
+
*/
|
|
50
|
+
export interface InventoryAdjustmentCreateParams {
|
|
51
|
+
/**
|
|
52
|
+
* `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
|
|
53
|
+
*/
|
|
54
|
+
account_ref: CurrencyRef;
|
|
55
|
+
/**
|
|
56
|
+
* Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
|
|
57
|
+
*/
|
|
58
|
+
class_ref?: CurrencyRef;
|
|
59
|
+
/**
|
|
60
|
+
* `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.
|
|
61
|
+
*/
|
|
62
|
+
customer_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<"AccountRef" | "ClassRef" | "CustomerRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "InventoryAdjustmentLineRet" | "InventorySiteRef" | "ListID" | "Memo" | "OwnerID" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
72
|
+
inventory_adjustment_line_add: InventoryAdjustmentLineAdd[];
|
|
73
|
+
/**
|
|
74
|
+
* Site where inventory is located.
|
|
75
|
+
*/
|
|
76
|
+
inventory_site_ref?: CurrencyRef;
|
|
77
|
+
/**
|
|
78
|
+
* Additional information.
|
|
79
|
+
*/
|
|
80
|
+
memo?: string;
|
|
81
|
+
/**
|
|
82
|
+
* `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.
|
|
83
|
+
*/
|
|
84
|
+
ref_number?: string;
|
|
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 `inventory_adjustment.query`: List inventory adjustments.
|
|
99
|
+
*/
|
|
100
|
+
export interface InventoryAdjustmentQueryParams {
|
|
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`, `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.
|
|
105
|
+
*/
|
|
106
|
+
account_filter?: AccountFilter;
|
|
107
|
+
/**
|
|
108
|
+
* 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.
|
|
109
|
+
*
|
|
110
|
+
* 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.
|
|
111
|
+
*/
|
|
112
|
+
entity_filter?: AccountFilter;
|
|
113
|
+
/**
|
|
114
|
+
* 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.
|
|
115
|
+
*/
|
|
116
|
+
include_line_items?: boolean;
|
|
117
|
+
include_ret_element?: Array<"AccountRef" | "ClassRef" | "CustomerRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "InventoryAdjustmentLineRet" | "InventorySiteRef" | "Memo" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
118
|
+
/**
|
|
119
|
+
* 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.
|
|
120
|
+
*
|
|
121
|
+
* 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.
|
|
122
|
+
*/
|
|
123
|
+
item_filter?: AccountFilter;
|
|
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`, `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.
|
|
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`, `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.
|
|
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`, `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.
|
|
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`, `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_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`, `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.
|
|
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`, `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.
|
|
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`, `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.
|
|
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`, `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.
|
|
188
|
+
*/
|
|
189
|
+
txn_id?: string[];
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The params of `inventory_adjustment.update`: Update inventory adjustment.
|
|
194
|
+
*/
|
|
195
|
+
export interface InventoryAdjustmentUpdateParams {
|
|
196
|
+
/**
|
|
197
|
+
* `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
|
|
198
|
+
*/
|
|
199
|
+
account_ref?: CurrencyRef;
|
|
200
|
+
/**
|
|
201
|
+
* Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
|
|
202
|
+
*/
|
|
203
|
+
class_ref?: CurrencyRef;
|
|
204
|
+
/**
|
|
205
|
+
* `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.
|
|
206
|
+
*/
|
|
207
|
+
customer_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<"AccountRef" | "ClassRef" | "CustomerRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "InventoryAdjustmentLineRet" | "InventorySiteRef" | "ListID" | "Memo" | "OwnerID" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
213
|
+
inventory_adjustment_line_mod?: InventoryAdjustmentLineMod[];
|
|
214
|
+
/**
|
|
215
|
+
* Site where inventory is located.
|
|
216
|
+
*/
|
|
217
|
+
inventory_site_ref?: CurrencyRef;
|
|
218
|
+
/**
|
|
219
|
+
* Additional information.
|
|
220
|
+
*/
|
|
221
|
+
memo?: string;
|
|
222
|
+
/**
|
|
223
|
+
* `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.
|
|
224
|
+
*/
|
|
225
|
+
ref_number?: string;
|
|
226
|
+
/**
|
|
227
|
+
* 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`.
|
|
228
|
+
*/
|
|
229
|
+
request_id?: string;
|
|
230
|
+
/**
|
|
231
|
+
* 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.
|
|
232
|
+
*
|
|
233
|
+
* Format: date.
|
|
234
|
+
*/
|
|
235
|
+
txn_date?: string;
|
|
236
|
+
/**
|
|
237
|
+
* `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.
|
|
238
|
+
*/
|
|
239
|
+
txn_id: string;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
export interface InventoryAdjustmentLineAdd {
|
|
243
|
+
/**
|
|
244
|
+
* `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
245
|
+
*/
|
|
246
|
+
item_ref: CurrencyRef;
|
|
247
|
+
/**
|
|
248
|
+
* Amount to adjust lot number.
|
|
249
|
+
*
|
|
250
|
+
* Choose exactly one of: `quantity_adjustment`, or `value_adjustment`, or `serial_number_adjustment`, or `lot_number_adjustment`.
|
|
251
|
+
*/
|
|
252
|
+
lot_number_adjustment?: LotNumberAdjustment;
|
|
253
|
+
/**
|
|
254
|
+
* Adjusts the inventory quantity either by setting a new quantity or by adjusting the current quantity up or down.
|
|
255
|
+
*
|
|
256
|
+
* Choose exactly one of: `quantity_adjustment`, or `value_adjustment`, or `serial_number_adjustment`, or `lot_number_adjustment`.
|
|
257
|
+
*/
|
|
258
|
+
quantity_adjustment?: QuantityAdjustment;
|
|
259
|
+
/**
|
|
260
|
+
* Serial number that will be adjusted in inventory.
|
|
261
|
+
*
|
|
262
|
+
* Choose exactly one of: `quantity_adjustment`, or `value_adjustment`, or `serial_number_adjustment`, or `lot_number_adjustment`.
|
|
263
|
+
*/
|
|
264
|
+
serial_number_adjustment?: SerialNumberAdjustment;
|
|
265
|
+
/**
|
|
266
|
+
* Adjusts the total value of these inventory items by setting a new monetary value, and optionally by setting a new quantity.
|
|
267
|
+
*
|
|
268
|
+
* Choose exactly one of: `quantity_adjustment`, or `value_adjustment`, or `serial_number_adjustment`, or `lot_number_adjustment`.
|
|
269
|
+
*/
|
|
270
|
+
value_adjustment?: ValueAdjustment;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
export interface InventoryAdjustmentLineMod {
|
|
274
|
+
/**
|
|
275
|
+
* Amount to adjust count.
|
|
276
|
+
*
|
|
277
|
+
* Choose exactly one of: `serial_number`, or the set (`count_adjustment`, `lot_number`). Members of a set combine with each other, not with the other choices.
|
|
278
|
+
*/
|
|
279
|
+
count_adjustment?: number;
|
|
280
|
+
/**
|
|
281
|
+
* Location within the Inventory Site.
|
|
282
|
+
*/
|
|
283
|
+
inventory_site_location_ref?: CurrencyRef;
|
|
284
|
+
/**
|
|
285
|
+
* `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
286
|
+
*/
|
|
287
|
+
item_ref?: CurrencyRef;
|
|
288
|
+
/**
|
|
289
|
+
* The lot number of the asset.
|
|
290
|
+
*
|
|
291
|
+
* Choose exactly one of: `serial_number`, or the set (`count_adjustment`, `lot_number`). Members of a set combine with each other, not with the other choices.
|
|
292
|
+
*/
|
|
293
|
+
lot_number?: string;
|
|
294
|
+
/**
|
|
295
|
+
* Either a positive or negative number that shows the change in quantity for this inventory item.
|
|
296
|
+
*/
|
|
297
|
+
quantity_difference?: number;
|
|
298
|
+
/**
|
|
299
|
+
* The serial number of the asset.
|
|
300
|
+
*
|
|
301
|
+
* Choose exactly one of: `serial_number`, or the set (`count_adjustment`, `lot_number`). Members of a set combine with each other, not with the other choices.
|
|
302
|
+
*/
|
|
303
|
+
serial_number?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
|
|
306
|
+
*/
|
|
307
|
+
txn_line_id: string;
|
|
308
|
+
/**
|
|
309
|
+
* Either a positive or negative number that shows a change in the total value of the entire stock of this inventory item.
|
|
310
|
+
*/
|
|
311
|
+
value_difference?: number;
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
export interface LotNumberAdjustment {
|
|
315
|
+
/**
|
|
316
|
+
* Amount to adjust count.
|
|
317
|
+
*/
|
|
318
|
+
count_adjustment?: number;
|
|
319
|
+
/**
|
|
320
|
+
* Location within the Inventory Site.
|
|
321
|
+
*/
|
|
322
|
+
inventory_site_location_ref?: CurrencyRef;
|
|
323
|
+
/**
|
|
324
|
+
* The lot number of the asset.
|
|
325
|
+
*/
|
|
326
|
+
lot_number?: string;
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Give exactly one of: `new_quantity`, or `quantity_difference`.
|
|
331
|
+
*/
|
|
332
|
+
export interface QuantityAdjustment {
|
|
333
|
+
/**
|
|
334
|
+
* Location within the Inventory Site.
|
|
335
|
+
*/
|
|
336
|
+
inventory_site_location_ref?: CurrencyRef;
|
|
337
|
+
/**
|
|
338
|
+
* The lot number of the asset.
|
|
339
|
+
*
|
|
340
|
+
* Choose at most one of: `serial_number`, or `lot_number`.
|
|
341
|
+
*/
|
|
342
|
+
lot_number?: string;
|
|
343
|
+
/**
|
|
344
|
+
* The new quantity for this inventory item.
|
|
345
|
+
*/
|
|
346
|
+
new_quantity?: number;
|
|
347
|
+
/**
|
|
348
|
+
* Either a positive or negative number that shows the change in quantity for this inventory item.
|
|
349
|
+
*/
|
|
350
|
+
quantity_difference?: number;
|
|
351
|
+
/**
|
|
352
|
+
* The serial number of the asset.
|
|
353
|
+
*
|
|
354
|
+
* Choose at most one of: `serial_number`, or `lot_number`.
|
|
355
|
+
*/
|
|
356
|
+
serial_number?: string;
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
* Give exactly one of: `add_serial_number`, or `remove_serial_number`.
|
|
361
|
+
*/
|
|
362
|
+
export interface SerialNumberAdjustment {
|
|
363
|
+
/**
|
|
364
|
+
* Serial number that will be added to inventory.
|
|
365
|
+
*/
|
|
366
|
+
add_serial_number?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Location within the Inventory Site.
|
|
369
|
+
*/
|
|
370
|
+
inventory_site_location_ref?: CurrencyRef;
|
|
371
|
+
/**
|
|
372
|
+
* Serial number that will be removed from inventory.
|
|
373
|
+
*/
|
|
374
|
+
remove_serial_number?: string;
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* Give exactly one of: `new_quantity`, or `quantity_difference`.
|
|
379
|
+
*/
|
|
380
|
+
export interface ValueAdjustment {
|
|
381
|
+
/**
|
|
382
|
+
* The new quantity for this inventory item.
|
|
383
|
+
*/
|
|
384
|
+
new_quantity?: number;
|
|
385
|
+
/**
|
|
386
|
+
* Either a positive or negative number that shows the change in quantity for this inventory item.
|
|
387
|
+
*/
|
|
388
|
+
quantity_difference?: number;
|
|
389
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks inventory adjustment operations. Types: inventory_adjustment.d.ts. */
|
|
5
|
+
class InventoryAdjustment {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create inventory adjustment.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./inventory_adjustment").InventoryAdjustmentCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/inventory-adjustments/create-inventory-adjustment
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("inventory_adjustment.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List inventory adjustments (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./inventory_adjustment").InventoryAdjustmentQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/inventory-adjustments/list-inventory-adjustments
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("inventory_adjustment.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update inventory adjustment.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./inventory_adjustment").InventoryAdjustmentUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/inventory-adjustments/update-inventory-adjustment
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("inventory_adjustment.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { InventoryAdjustment };
|