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,82 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AccountFilterPaycheck, ModifiedDateRangeFilterPaycheck, PayrollDateRangeFilter, RefNumberFilterPaycheck, RefNumberRangeFilterPaycheck, TxnDateRangeFilterPaycheck } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks payroll liability check operations: `qube.payrollLiabilityCheck.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class PayrollLiabilityCheck {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List payroll liability checks: `GET /connections/{connection_id}/payroll-liability-checks`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `account_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `max_returned`, `meta_data`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-liability-checks/list-payroll-liability-checks
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: PayrollLiabilityCheckQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `payroll_liability_check.query`: List payroll liability checks.
|
|
25
|
+
*/
|
|
26
|
+
export interface PayrollLiabilityCheckQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
29
|
+
*/
|
|
30
|
+
account_filter?: AccountFilterPaycheck;
|
|
31
|
+
/**
|
|
32
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
33
|
+
*/
|
|
34
|
+
entity_filter?: AccountFilterPaycheck;
|
|
35
|
+
include_line_items?: boolean;
|
|
36
|
+
include_ret_element?: Array<"AccountRef" | "Address" | "Amount" | "EditSequence" | "IsToBePrinted" | "Memo" | "PayrollDate" | "PayrollLiabilityCheckLineRet" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber" | "VendorRef">;
|
|
37
|
+
/**
|
|
38
|
+
* QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
|
|
39
|
+
*
|
|
40
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
41
|
+
*
|
|
42
|
+
* Minimum 1.
|
|
43
|
+
*/
|
|
44
|
+
max_returned?: number;
|
|
45
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
46
|
+
/**
|
|
47
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
48
|
+
*/
|
|
49
|
+
modified_date_range_filter?: ModifiedDateRangeFilterPaycheck;
|
|
50
|
+
/**
|
|
51
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
52
|
+
*/
|
|
53
|
+
payroll_date_range_filter?: PayrollDateRangeFilter;
|
|
54
|
+
/**
|
|
55
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
56
|
+
*/
|
|
57
|
+
ref_number?: string[];
|
|
58
|
+
/**
|
|
59
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
60
|
+
*/
|
|
61
|
+
ref_number_case_sensitive?: string[];
|
|
62
|
+
/**
|
|
63
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
64
|
+
*/
|
|
65
|
+
ref_number_filter?: RefNumberFilterPaycheck;
|
|
66
|
+
/**
|
|
67
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
68
|
+
*/
|
|
69
|
+
ref_number_range_filter?: RefNumberRangeFilterPaycheck;
|
|
70
|
+
/**
|
|
71
|
+
* Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
|
|
72
|
+
*/
|
|
73
|
+
request_id?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
76
|
+
*/
|
|
77
|
+
txn_date_range_filter?: TxnDateRangeFilterPaycheck;
|
|
78
|
+
/**
|
|
79
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
80
|
+
*/
|
|
81
|
+
txn_id?: string[];
|
|
82
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks payroll liability check operations. Types: payroll_liability_check.d.ts. */
|
|
5
|
+
class PayrollLiabilityCheck {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List payroll liability checks.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./payroll_liability_check").PayrollLiabilityCheckQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-liability-checks/list-payroll-liability-checks
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("payroll_liability_check.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { PayrollLiabilityCheck };
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AccountFilterPaycheck, ClassRef, ModifiedDateRangeFilterPaycheck, PayrollDateRangeFilter, RefNumberFilterPaycheck, RefNumberRangeFilterPaycheck, TxnDateRangeFilterPaycheck } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks payroll prior payment operations: `qube.payrollPriorPayment.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class PayrollPriorPayment {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create payroll prior payment: `POST /connections/{connection_id}/payroll-prior-payments`, 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`, `def_macro`, `include_ret_element`, `is_affecting_accounts` (required), `memo`, `payroll_date`, `payroll_prior_payment_line_add` (required), `ref_number`, `request_id`, `txn_date`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-prior-payments/create-payroll-prior-payment
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: PayrollPriorPaymentCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List payroll prior payments: `GET /connections/{connection_id}/payroll-prior-payments`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `account_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `max_returned`, `meta_data`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-prior-payments/list-payroll-prior-payments
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: PayrollPriorPaymentQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `payroll_prior_payment.create`: Create payroll prior payment.
|
|
37
|
+
*/
|
|
38
|
+
export interface PayrollPriorPaymentCreateParams {
|
|
39
|
+
account_ref?: ClassRef;
|
|
40
|
+
def_macro?: string;
|
|
41
|
+
include_ret_element?: Array<"AccountRef" | "Amount" | "EditSequence" | "IsAffectingAccounts" | "Memo" | "PayrollDate" | "PayrollPriorPaymentLineRet" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
42
|
+
is_affecting_accounts: boolean;
|
|
43
|
+
memo?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Format: date.
|
|
46
|
+
*/
|
|
47
|
+
payroll_date?: string;
|
|
48
|
+
payroll_prior_payment_line_add: PayrollPriorPaymentLineAdd[];
|
|
49
|
+
ref_number?: string;
|
|
50
|
+
/**
|
|
51
|
+
* 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`.
|
|
52
|
+
*/
|
|
53
|
+
request_id?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Format: date.
|
|
56
|
+
*/
|
|
57
|
+
txn_date?: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* The params of `payroll_prior_payment.query`: List payroll prior payments.
|
|
62
|
+
*/
|
|
63
|
+
export interface PayrollPriorPaymentQueryParams {
|
|
64
|
+
/**
|
|
65
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
66
|
+
*/
|
|
67
|
+
account_filter?: AccountFilterPaycheck;
|
|
68
|
+
/**
|
|
69
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
70
|
+
*/
|
|
71
|
+
entity_filter?: AccountFilterPaycheck;
|
|
72
|
+
include_line_items?: boolean;
|
|
73
|
+
include_ret_element?: Array<"AccountRef" | "Amount" | "EditSequence" | "IsAffectingAccounts" | "Memo" | "PayrollDate" | "PayrollPriorPaymentLineRet" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
74
|
+
/**
|
|
75
|
+
* QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
|
|
76
|
+
*
|
|
77
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
78
|
+
*
|
|
79
|
+
* Minimum 1.
|
|
80
|
+
*/
|
|
81
|
+
max_returned?: number;
|
|
82
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
83
|
+
/**
|
|
84
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
85
|
+
*/
|
|
86
|
+
modified_date_range_filter?: ModifiedDateRangeFilterPaycheck;
|
|
87
|
+
/**
|
|
88
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
89
|
+
*/
|
|
90
|
+
payroll_date_range_filter?: PayrollDateRangeFilter;
|
|
91
|
+
/**
|
|
92
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
93
|
+
*/
|
|
94
|
+
ref_number?: string[];
|
|
95
|
+
/**
|
|
96
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
97
|
+
*/
|
|
98
|
+
ref_number_case_sensitive?: string[];
|
|
99
|
+
/**
|
|
100
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
101
|
+
*/
|
|
102
|
+
ref_number_filter?: RefNumberFilterPaycheck;
|
|
103
|
+
/**
|
|
104
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
105
|
+
*/
|
|
106
|
+
ref_number_range_filter?: RefNumberRangeFilterPaycheck;
|
|
107
|
+
/**
|
|
108
|
+
* 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`.
|
|
109
|
+
*/
|
|
110
|
+
request_id?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
113
|
+
*/
|
|
114
|
+
txn_date_range_filter?: TxnDateRangeFilterPaycheck;
|
|
115
|
+
/**
|
|
116
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
117
|
+
*/
|
|
118
|
+
txn_id?: string[];
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export interface PayrollPriorPaymentLineAdd {
|
|
122
|
+
account_ref?: ClassRef;
|
|
123
|
+
amount?: number;
|
|
124
|
+
memo?: string;
|
|
125
|
+
payroll_item_ref?: ClassRef;
|
|
126
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks payroll prior payment operations. Types: payroll_prior_payment.d.ts. */
|
|
5
|
+
class PayrollPriorPayment {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create payroll prior payment.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./payroll_prior_payment").PayrollPriorPaymentCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-prior-payments/create-payroll-prior-payment
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("payroll_prior_payment.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List payroll prior payments.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./payroll_prior_payment").PayrollPriorPaymentQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-prior-payments/list-payroll-prior-payments
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("payroll_prior_payment.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
module.exports = { PayrollPriorPayment };
|
|
@@ -0,0 +1,107 @@
|
|
|
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 } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks payroll summary report operations: `qube.payrollSummaryReport.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class PayrollSummaryReport {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List payroll summary reports: `GET /connections/{connection_id}/payroll-summary-reports`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `display_report`, `include_subcolumns`, `payroll_summary_report_type` (required), `report_account_filter`, `report_calendar`, `report_class_filter`, `report_date_macro`, `report_detail_level_filter`, `report_entity_filter`, `report_item_filter`, `report_modified_date_range_filter`, `report_modified_date_range_macro`, `report_period`, `report_posting_status_filter`, `request_id`, `return_columns`, `return_rows`, `summarize_columns_by`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-summary-reports/list-payroll-summary-reports
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: PayrollSummaryReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `payroll_summary_report.query`: List payroll summary reports.
|
|
25
|
+
*/
|
|
26
|
+
export interface PayrollSummaryReportQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
|
|
29
|
+
*/
|
|
30
|
+
display_report?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* The default value is false, which means that the report won’t include any subcolumn information. To include all available types of subcolumns for this report, set `include_subcolumns` to true. The SDK won’t return subcolumn information for data that can be easily computed. (For example, the SDK doesn’t return the “percent of row” column.)
|
|
33
|
+
*/
|
|
34
|
+
include_subcolumns?: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* The type of payroll report: psrtEmployeeEarningsSummary This report shows information similar to the payroll summary report, but in a different layout.
|
|
37
|
+
*/
|
|
38
|
+
payroll_summary_report_type: "EmployeeEarningsSummary" | "PayrollLiabilityBalances" | "PayrollSummary";
|
|
39
|
+
/**
|
|
40
|
+
* Allows you to query for a specified account type or for specific list elements.
|
|
41
|
+
*/
|
|
42
|
+
report_account_filter?: ReportAccountFilter;
|
|
43
|
+
/**
|
|
44
|
+
* Specifies the type of year that will be used for this report.
|
|
45
|
+
*/
|
|
46
|
+
report_calendar?: "CalendarYear" | "FiscalYear" | "TaxYear";
|
|
47
|
+
/**
|
|
48
|
+
* 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.
|
|
49
|
+
*/
|
|
50
|
+
report_class_filter?: ReportClassFilter;
|
|
51
|
+
/**
|
|
52
|
+
* The time period covered by this report.
|
|
53
|
+
*
|
|
54
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
55
|
+
*/
|
|
56
|
+
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";
|
|
57
|
+
/**
|
|
58
|
+
* The level of detail to include in the report.
|
|
59
|
+
*/
|
|
60
|
+
report_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
|
|
61
|
+
/**
|
|
62
|
+
* Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
|
|
63
|
+
*/
|
|
64
|
+
report_entity_filter?: ReportEntityFilter;
|
|
65
|
+
/**
|
|
66
|
+
* Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
|
|
67
|
+
*/
|
|
68
|
+
report_item_filter?: ReportItemFilter;
|
|
69
|
+
/**
|
|
70
|
+
* 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).
|
|
71
|
+
*
|
|
72
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
73
|
+
*/
|
|
74
|
+
report_modified_date_range_filter?: ReportModifiedDateRangeFilter;
|
|
75
|
+
/**
|
|
76
|
+
* The time period covered by this report.
|
|
77
|
+
*
|
|
78
|
+
* Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
79
|
+
*/
|
|
80
|
+
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";
|
|
81
|
+
/**
|
|
82
|
+
* If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
|
|
83
|
+
*
|
|
84
|
+
* Choose at most one of: `report_period`, or `report_date_macro`.
|
|
85
|
+
*/
|
|
86
|
+
report_period?: ReportPeriod;
|
|
87
|
+
/**
|
|
88
|
+
* Allows you to query for posting reports, non-posting reports, or reports that are either one.
|
|
89
|
+
*/
|
|
90
|
+
report_posting_status_filter?: "Either" | "NonPosting" | "Posting";
|
|
91
|
+
/**
|
|
92
|
+
* 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`.
|
|
93
|
+
*/
|
|
94
|
+
request_id?: string;
|
|
95
|
+
/**
|
|
96
|
+
* Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
|
|
97
|
+
*/
|
|
98
|
+
return_columns?: "ActiveOnly" | "All" | "NonZero";
|
|
99
|
+
/**
|
|
100
|
+
* Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
|
|
101
|
+
*/
|
|
102
|
+
return_rows?: "ActiveOnly" | "All" | "NonZero";
|
|
103
|
+
/**
|
|
104
|
+
* `summarize_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report. For example, if you set the value to scbTwoWeek, the report’s column labels might be “Feb 10-23, 02,” “Feb 24-Mar9, 02,” and so on.
|
|
105
|
+
*/
|
|
106
|
+
summarize_columns_by?: "Account" | "BalanceSheet" | "Class" | "Customer" | "CustomerType" | "Day" | "Employee" | "FourWeek" | "HalfMonth" | "IncomeStatement" | "ItemDetail" | "ItemType" | "Month" | "Payee" | "PaymentMethod" | "PayrollItemDetail" | "PayrollYtdDetail" | "Quarter" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "Terms" | "TotalOnly" | "TwoWeek" | "Vendor" | "VendorType" | "Week" | "Year";
|
|
107
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks payroll summary report operations. Types: payroll_summary_report.d.ts. */
|
|
5
|
+
class PayrollSummaryReport {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List payroll summary reports.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./payroll_summary_report").PayrollSummaryReportQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-summary-reports/list-payroll-summary-reports
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("payroll_summary_report.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { PayrollSummaryReport };
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AccountFilterPaycheck, ClassRef, ModifiedDateRangeFilterPaycheck, PayrollDateRangeFilter, RefNumberFilterPaycheck, RefNumberRangeFilterPaycheck, TxnDateRangeFilterPaycheck } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks payroll year to date adjustment operations: `qube.payrollYearToDateAdjustment.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class PayrollYearToDateAdjustment {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create payroll year to date adjustment: `POST /connections/{connection_id}/payroll-year-to-date-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`, `class_ref`, `def_macro`, `employee_ref` (required), `include_ret_element`, `is_affecting_accounts` (required), `memo`, `pay_period_begin_date`, `pay_period_end_date`, `payroll_date`, `payroll_year_to_date_adjustment_line_add` (required), `ref_number`, `request_id`, `tax_table_version`, `txn_date`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-year-to-date-adjustments/create-payroll-year-to-date-adjustment
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: PayrollYearToDateAdjustmentCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List payroll year to date adjustments: `GET /connections/{connection_id}/payroll-year-to-date-adjustments`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `account_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `max_returned`, `meta_data`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-year-to-date-adjustments/list-payroll-year-to-date-adjustments
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: PayrollYearToDateAdjustmentQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `payroll_year_to_date_adjustment.create`: Create payroll year to date adjustment.
|
|
37
|
+
*/
|
|
38
|
+
export interface PayrollYearToDateAdjustmentCreateParams {
|
|
39
|
+
account_ref?: ClassRef;
|
|
40
|
+
class_ref?: ClassRef;
|
|
41
|
+
def_macro?: string;
|
|
42
|
+
employee_ref: ClassRef;
|
|
43
|
+
include_ret_element?: Array<"AccountRef" | "Amount" | "ClassRef" | "EditSequence" | "EmployeeRef" | "IsAffectingAccounts" | "Memo" | "PayPeriodBeginDate" | "PayPeriodEndDate" | "PayrollDate" | "PayrollYearToDateAdjustmentLineRet" | "RefNumber" | "TaxTableVersion" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
44
|
+
is_affecting_accounts: boolean;
|
|
45
|
+
memo?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Format: date.
|
|
48
|
+
*/
|
|
49
|
+
pay_period_begin_date?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Format: date.
|
|
52
|
+
*/
|
|
53
|
+
pay_period_end_date?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Format: date.
|
|
56
|
+
*/
|
|
57
|
+
payroll_date?: string;
|
|
58
|
+
payroll_year_to_date_adjustment_line_add: PayrollYearToDateAdjustmentLineAdd[];
|
|
59
|
+
ref_number?: string;
|
|
60
|
+
/**
|
|
61
|
+
* 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`.
|
|
62
|
+
*/
|
|
63
|
+
request_id?: string;
|
|
64
|
+
tax_table_version?: number;
|
|
65
|
+
/**
|
|
66
|
+
* Format: date.
|
|
67
|
+
*/
|
|
68
|
+
txn_date?: string;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* The params of `payroll_year_to_date_adjustment.query`: List payroll year to date adjustments.
|
|
73
|
+
*/
|
|
74
|
+
export interface PayrollYearToDateAdjustmentQueryParams {
|
|
75
|
+
/**
|
|
76
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
77
|
+
*/
|
|
78
|
+
account_filter?: AccountFilterPaycheck;
|
|
79
|
+
/**
|
|
80
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
81
|
+
*/
|
|
82
|
+
entity_filter?: AccountFilterPaycheck;
|
|
83
|
+
include_line_items?: boolean;
|
|
84
|
+
include_ret_element?: Array<"AccountRef" | "Amount" | "ClassRef" | "EditSequence" | "EmployeeRef" | "IsAffectingAccounts" | "Memo" | "PayPeriodBeginDate" | "PayPeriodEndDate" | "PayrollDate" | "PayrollYearToDateAdjustmentLineRet" | "RefNumber" | "TaxTableVersion" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
|
|
85
|
+
/**
|
|
86
|
+
* QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
|
|
87
|
+
*
|
|
88
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
89
|
+
*
|
|
90
|
+
* Minimum 1.
|
|
91
|
+
*/
|
|
92
|
+
max_returned?: number;
|
|
93
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
94
|
+
/**
|
|
95
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
96
|
+
*/
|
|
97
|
+
modified_date_range_filter?: ModifiedDateRangeFilterPaycheck;
|
|
98
|
+
/**
|
|
99
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
100
|
+
*/
|
|
101
|
+
payroll_date_range_filter?: PayrollDateRangeFilter;
|
|
102
|
+
/**
|
|
103
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
104
|
+
*/
|
|
105
|
+
ref_number?: string[];
|
|
106
|
+
/**
|
|
107
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
108
|
+
*/
|
|
109
|
+
ref_number_case_sensitive?: string[];
|
|
110
|
+
/**
|
|
111
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
112
|
+
*/
|
|
113
|
+
ref_number_filter?: RefNumberFilterPaycheck;
|
|
114
|
+
/**
|
|
115
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
116
|
+
*/
|
|
117
|
+
ref_number_range_filter?: RefNumberRangeFilterPaycheck;
|
|
118
|
+
/**
|
|
119
|
+
* 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`.
|
|
120
|
+
*/
|
|
121
|
+
request_id?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
124
|
+
*/
|
|
125
|
+
txn_date_range_filter?: TxnDateRangeFilterPaycheck;
|
|
126
|
+
/**
|
|
127
|
+
* Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
|
|
128
|
+
*/
|
|
129
|
+
txn_id?: string[];
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export interface PayrollYearToDateAdjustmentLineAdd {
|
|
133
|
+
account_ref?: ClassRef;
|
|
134
|
+
amount?: number;
|
|
135
|
+
calculated_amount?: number;
|
|
136
|
+
class_ref?: ClassRef;
|
|
137
|
+
company_paid_attribute?: "IsExpense" | "IsLiability" | "IsLiabilityAndExpense" | "NotApplicable";
|
|
138
|
+
experience_mod_rate_amount?: number;
|
|
139
|
+
hours_worked?: string;
|
|
140
|
+
income_subject_to_tax_amount?: number;
|
|
141
|
+
is_amount_overridden?: boolean;
|
|
142
|
+
memo?: string;
|
|
143
|
+
other_account_ref?: ClassRef;
|
|
144
|
+
payroll_item_ref?: ClassRef;
|
|
145
|
+
/**
|
|
146
|
+
* Choose at most one of: `rate`, or `rate_percent`.
|
|
147
|
+
*/
|
|
148
|
+
rate?: number;
|
|
149
|
+
/**
|
|
150
|
+
* Choose at most one of: `rate`, or `rate_percent`.
|
|
151
|
+
*/
|
|
152
|
+
rate_percent?: number;
|
|
153
|
+
wage_base_amount?: number;
|
|
154
|
+
workers_comp_amount?: number;
|
|
155
|
+
workers_comp_code_ref?: ClassRef;
|
|
156
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks payroll year to date adjustment operations. Types: payroll_year_to_date_adjustment.d.ts. */
|
|
5
|
+
class PayrollYearToDateAdjustment {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create payroll year to date adjustment.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./payroll_year_to_date_adjustment").PayrollYearToDateAdjustmentCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-year-to-date-adjustments/create-payroll-year-to-date-adjustment
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("payroll_year_to_date_adjustment.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List payroll year to date adjustments.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./payroll_year_to_date_adjustment").PayrollYearToDateAdjustmentQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/payroll-year-to-date-adjustments/list-payroll-year-to-date-adjustments
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("payroll_year_to_date_adjustment.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
module.exports = { PayrollYearToDateAdjustment };
|