qube_sync 0.3.0 → 0.4.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +48 -0
- data/README.md +235 -75
- data/Rakefile +12 -0
- data/lib/qube_sync/client.rb +579 -0
- data/lib/qube_sync/operations/account.rb +337 -0
- data/lib/qube_sync/operations/account_tax_line_info.rb +30 -0
- data/lib/qube_sync/operations/aging_report.rb +160 -0
- data/lib/qube_sync/operations/alert.rb +91 -0
- data/lib/qube_sync/operations/ar_refund_credit_card.rb +399 -0
- data/lib/qube_sync/operations/bar_code.rb +37 -0
- data/lib/qube_sync/operations/bill.rb +1073 -0
- data/lib/qube_sync/operations/bill_payment_check.rb +413 -0
- data/lib/qube_sync/operations/bill_payment_credit_card.rb +315 -0
- data/lib/qube_sync/operations/bill_to_pay.rb +66 -0
- data/lib/qube_sync/operations/billing_rate.rb +172 -0
- data/lib/qube_sync/operations/budget_summary_report.rb +80 -0
- data/lib/qube_sync/operations/build_assembly.rb +318 -0
- data/lib/qube_sync/operations/charge.rb +452 -0
- data/lib/qube_sync/operations/check.rb +1055 -0
- data/lib/qube_sync/operations/class.rb +176 -0
- data/lib/qube_sync/operations/cleared_status.rb +39 -0
- data/lib/qube_sync/operations/company.rb +39 -0
- data/lib/qube_sync/operations/company_activity.rb +31 -0
- data/lib/qube_sync/operations/credit_card_charge.rb +1000 -0
- data/lib/qube_sync/operations/credit_card_credit.rb +1000 -0
- data/lib/qube_sync/operations/credit_memo.rb +1243 -0
- data/lib/qube_sync/operations/currency.rb +195 -0
- data/lib/qube_sync/operations/custom_detail_report.rb +176 -0
- data/lib/qube_sync/operations/custom_summary_report.rb +180 -0
- data/lib/qube_sync/operations/customer.rb +744 -0
- data/lib/qube_sync/operations/customer_msg.rb +117 -0
- data/lib/qube_sync/operations/customer_type.rb +133 -0
- data/lib/qube_sync/operations/data_event_recovery_info.rb +54 -0
- data/lib/qube_sync/operations/data_ext.rb +201 -0
- data/lib/qube_sync/operations/data_ext_def.rb +179 -0
- data/lib/qube_sync/operations/date_driven_terms.rb +131 -0
- data/lib/qube_sync/operations/deposit.rb +555 -0
- data/lib/qube_sync/operations/employee.rb +577 -0
- data/lib/qube_sync/operations/employee_default.rb +100 -0
- data/lib/qube_sync/operations/entity.rb +118 -0
- data/lib/qube_sync/operations/estimate.rb +1055 -0
- data/lib/qube_sync/operations/form1099_category_account_mapping.rb +90 -0
- data/lib/qube_sync/operations/general_detail_report.rb +185 -0
- data/lib/qube_sync/operations/general_summary_report.rb +180 -0
- data/lib/qube_sync/operations/host.rb +36 -0
- data/lib/qube_sync/operations/inventory_adjustment.rb +482 -0
- data/lib/qube_sync/operations/inventory_site.rb +214 -0
- data/lib/qube_sync/operations/invoice.rb +1208 -0
- data/lib/qube_sync/operations/item.rb +115 -0
- data/lib/qube_sync/operations/item_assemblies_can_build.rb +44 -0
- data/lib/qube_sync/operations/item_discount.rb +319 -0
- data/lib/qube_sync/operations/item_fixed_asset.rb +317 -0
- data/lib/qube_sync/operations/item_group.rb +253 -0
- data/lib/qube_sync/operations/item_inventory.rb +446 -0
- data/lib/qube_sync/operations/item_inventory_assembly.rb +483 -0
- data/lib/qube_sync/operations/item_non_inventory.rb +461 -0
- data/lib/qube_sync/operations/item_other_charge.rb +434 -0
- data/lib/qube_sync/operations/item_payment.rb +268 -0
- data/lib/qube_sync/operations/item_receipt.rb +1011 -0
- data/lib/qube_sync/operations/item_sales_tax.rb +270 -0
- data/lib/qube_sync/operations/item_sales_tax_group.rb +200 -0
- data/lib/qube_sync/operations/item_service.rb +455 -0
- data/lib/qube_sync/operations/item_sites.rb +96 -0
- data/lib/qube_sync/operations/item_subtotal.rb +182 -0
- data/lib/qube_sync/operations/job_report.rb +156 -0
- data/lib/qube_sync/operations/job_type.rb +131 -0
- data/lib/qube_sync/operations/journal_entry.rb +518 -0
- data/lib/qube_sync/operations/lead.rb +216 -0
- data/lib/qube_sync/operations/list.rb +42 -0
- data/lib/qube_sync/operations/list_deleted.rb +57 -0
- data/lib/qube_sync/operations/list_display.rb +59 -0
- data/lib/qube_sync/operations/list_merge.rb +55 -0
- data/lib/qube_sync/operations/other_name.rb +245 -0
- data/lib/qube_sync/operations/paycheck.rb +139 -0
- data/lib/qube_sync/operations/payment_method.rb +128 -0
- data/lib/qube_sync/operations/payroll_detail_report.rb +161 -0
- data/lib/qube_sync/operations/payroll_item.rb +75 -0
- data/lib/qube_sync/operations/payroll_item_addition.rb +98 -0
- data/lib/qube_sync/operations/payroll_item_company_contribution.rb +134 -0
- data/lib/qube_sync/operations/payroll_item_deduction.rb +124 -0
- data/lib/qube_sync/operations/payroll_item_direct_deposit.rb +70 -0
- data/lib/qube_sync/operations/payroll_item_non_wage.rb +93 -0
- data/lib/qube_sync/operations/payroll_item_tax.rb +123 -0
- data/lib/qube_sync/operations/payroll_item_wage.rb +168 -0
- data/lib/qube_sync/operations/payroll_item_workers_compensation.rb +108 -0
- data/lib/qube_sync/operations/payroll_last_period.rb +30 -0
- data/lib/qube_sync/operations/payroll_liability_adjustment.rb +204 -0
- data/lib/qube_sync/operations/payroll_liability_check.rb +137 -0
- data/lib/qube_sync/operations/payroll_prior_payment.rb +178 -0
- data/lib/qube_sync/operations/payroll_summary_report.rb +157 -0
- data/lib/qube_sync/operations/payroll_year_to_date_adjustment.rb +211 -0
- data/lib/qube_sync/operations/preferences.rb +61 -0
- data/lib/qube_sync/operations/price_level.rb +305 -0
- data/lib/qube_sync/operations/purchase_order.rb +1038 -0
- data/lib/qube_sync/operations/qb_command_exec.rb +37 -0
- data/lib/qube_sync/operations/receive_payment.rb +627 -0
- data/lib/qube_sync/operations/receive_payment_to_deposit.rb +38 -0
- data/lib/qube_sync/operations/sales_order.rb +1045 -0
- data/lib/qube_sync/operations/sales_receipt.rb +1337 -0
- data/lib/qube_sync/operations/sales_rep.rb +172 -0
- data/lib/qube_sync/operations/sales_tax_code.rb +205 -0
- data/lib/qube_sync/operations/sales_tax_payable.rb +37 -0
- data/lib/qube_sync/operations/sales_tax_payment_check.rb +375 -0
- data/lib/qube_sync/operations/sales_tax_return.rb +35 -0
- data/lib/qube_sync/operations/sales_tax_return_line.rb +43 -0
- data/lib/qube_sync/operations/ship_method.rb +116 -0
- data/lib/qube_sync/operations/special_account.rb +55 -0
- data/lib/qube_sync/operations/special_item.rb +44 -0
- data/lib/qube_sync/operations/standard_terms.rb +125 -0
- data/lib/qube_sync/operations/template.rb +36 -0
- data/lib/qube_sync/operations/terms.rb +91 -0
- data/lib/qube_sync/operations/time_report.rb +127 -0
- data/lib/qube_sync/operations/time_tracking.rb +303 -0
- data/lib/qube_sync/operations/to_do.rb +260 -0
- data/lib/qube_sync/operations/transaction.rb +356 -0
- data/lib/qube_sync/operations/transfer.rb +213 -0
- data/lib/qube_sync/operations/transfer_inventory.rb +384 -0
- data/lib/qube_sync/operations/txn.rb +38 -0
- data/lib/qube_sync/operations/txn_deleted.rb +54 -0
- data/lib/qube_sync/operations/txn_display.rb +76 -0
- data/lib/qube_sync/operations/txn_void.rb +36 -0
- data/lib/qube_sync/operations/unit_of_measure_set.rb +149 -0
- data/lib/qube_sync/operations/vehicle.rb +152 -0
- data/lib/qube_sync/operations/vehicle_mileage.rb +191 -0
- data/lib/qube_sync/operations/vendor.rb +661 -0
- data/lib/qube_sync/operations/vendor_credit.rb +1008 -0
- data/lib/qube_sync/operations/vendor_type.rb +131 -0
- data/lib/qube_sync/operations/workers_comp_code.rb +184 -0
- data/lib/qube_sync/operations.rb +1165 -0
- data/lib/qube_sync/version.rb +1 -1
- data/lib/qube_sync.rb +1 -0
- data/sig/qube_sync/client.rbs +82 -0
- data/sig/qube_sync/operations/account.rbs +65 -0
- data/sig/qube_sync/operations/account_tax_line_info.rbs +13 -0
- data/sig/qube_sync/operations/aging_report.rbs +29 -0
- data/sig/qube_sync/operations/alert.rbs +53 -0
- data/sig/qube_sync/operations/ar_refund_credit_card.rbs +53 -0
- data/sig/qube_sync/operations/bar_code.rbs +16 -0
- data/sig/qube_sync/operations/bill.rbs +78 -0
- data/sig/qube_sync/operations/bill_payment_check.rbs +62 -0
- data/sig/qube_sync/operations/bill_payment_credit_card.rbs +45 -0
- data/sig/qube_sync/operations/bill_to_pay.rbs +19 -0
- data/sig/qube_sync/operations/billing_rate.rbs +40 -0
- data/sig/qube_sync/operations/budget_summary_report.rbs +22 -0
- data/sig/qube_sync/operations/build_assembly.rbs +64 -0
- data/sig/qube_sync/operations/charge.rbs +80 -0
- data/sig/qube_sync/operations/check.rbs +81 -0
- data/sig/qube_sync/operations/class.rbs +43 -0
- data/sig/qube_sync/operations/cleared_status.rbs +16 -0
- data/sig/qube_sync/operations/company.rbs +15 -0
- data/sig/qube_sync/operations/company_activity.rbs +14 -0
- data/sig/qube_sync/operations/credit_card_charge.rbs +69 -0
- data/sig/qube_sync/operations/credit_card_credit.rbs +69 -0
- data/sig/qube_sync/operations/credit_memo.rbs +162 -0
- data/sig/qube_sync/operations/currency.rbs +52 -0
- data/sig/qube_sync/operations/custom_detail_report.rbs +31 -0
- data/sig/qube_sync/operations/custom_summary_report.rbs +33 -0
- data/sig/qube_sync/operations/customer.rbs +174 -0
- data/sig/qube_sync/operations/customer_msg.rbs +31 -0
- data/sig/qube_sync/operations/customer_type.rbs +32 -0
- data/sig/qube_sync/operations/data_event_recovery_info.rbs +20 -0
- data/sig/qube_sync/operations/data_ext.rbs +53 -0
- data/sig/qube_sync/operations/data_ext_def.rbs +51 -0
- data/sig/qube_sync/operations/date_driven_terms.rbs +35 -0
- data/sig/qube_sync/operations/deposit.rbs +100 -0
- data/sig/qube_sync/operations/employee.rbs +173 -0
- data/sig/qube_sync/operations/employee_default.rbs +68 -0
- data/sig/qube_sync/operations/entity.rbs +24 -0
- data/sig/qube_sync/operations/estimate.rbs +148 -0
- data/sig/qube_sync/operations/form1099_category_account_mapping.rbs +33 -0
- data/sig/qube_sync/operations/general_detail_report.rbs +31 -0
- data/sig/qube_sync/operations/general_summary_report.rbs +32 -0
- data/sig/qube_sync/operations/host.rbs +19 -0
- data/sig/qube_sync/operations/inventory_adjustment.rbs +105 -0
- data/sig/qube_sync/operations/inventory_site.rbs +66 -0
- data/sig/qube_sync/operations/invoice.rbs +144 -0
- data/sig/qube_sync/operations/item.rbs +25 -0
- data/sig/qube_sync/operations/item_assemblies_can_build.rbs +15 -0
- data/sig/qube_sync/operations/item_discount.rbs +62 -0
- data/sig/qube_sync/operations/item_fixed_asset.rbs +97 -0
- data/sig/qube_sync/operations/item_group.rbs +62 -0
- data/sig/qube_sync/operations/item_inventory.rbs +87 -0
- data/sig/qube_sync/operations/item_inventory_assembly.rbs +94 -0
- data/sig/qube_sync/operations/item_non_inventory.rbs +64 -0
- data/sig/qube_sync/operations/item_other_charge.rbs +59 -0
- data/sig/qube_sync/operations/item_payment.rbs +55 -0
- data/sig/qube_sync/operations/item_receipt.rbs +71 -0
- data/sig/qube_sync/operations/item_sales_tax.rbs +57 -0
- data/sig/qube_sync/operations/item_sales_tax_group.rbs +50 -0
- data/sig/qube_sync/operations/item_service.rbs +62 -0
- data/sig/qube_sync/operations/item_sites.rbs +26 -0
- data/sig/qube_sync/operations/item_subtotal.rbs +48 -0
- data/sig/qube_sync/operations/job_report.rbs +28 -0
- data/sig/qube_sync/operations/job_type.rbs +32 -0
- data/sig/qube_sync/operations/journal_entry.rbs +88 -0
- data/sig/qube_sync/operations/lead.rbs +91 -0
- data/sig/qube_sync/operations/list.rbs +15 -0
- data/sig/qube_sync/operations/list_deleted.rbs +17 -0
- data/sig/qube_sync/operations/list_display.rbs +21 -0
- data/sig/qube_sync/operations/list_merge.rbs +22 -0
- data/sig/qube_sync/operations/other_name.rbs +71 -0
- data/sig/qube_sync/operations/paycheck.rbs +27 -0
- data/sig/qube_sync/operations/payment_method.rbs +33 -0
- data/sig/qube_sync/operations/payroll_detail_report.rbs +29 -0
- data/sig/qube_sync/operations/payroll_item.rbs +23 -0
- data/sig/qube_sync/operations/payroll_item_addition.rbs +48 -0
- data/sig/qube_sync/operations/payroll_item_company_contribution.rbs +58 -0
- data/sig/qube_sync/operations/payroll_item_deduction.rbs +54 -0
- data/sig/qube_sync/operations/payroll_item_direct_deposit.rbs +30 -0
- data/sig/qube_sync/operations/payroll_item_non_wage.rbs +23 -0
- data/sig/qube_sync/operations/payroll_item_tax.rbs +58 -0
- data/sig/qube_sync/operations/payroll_item_wage.rbs +48 -0
- data/sig/qube_sync/operations/payroll_item_workers_compensation.rbs +42 -0
- data/sig/qube_sync/operations/payroll_last_period.rbs +13 -0
- data/sig/qube_sync/operations/payroll_liability_adjustment.rbs +59 -0
- data/sig/qube_sync/operations/payroll_liability_check.rbs +27 -0
- data/sig/qube_sync/operations/payroll_prior_payment.rbs +48 -0
- data/sig/qube_sync/operations/payroll_summary_report.rbs +30 -0
- data/sig/qube_sync/operations/payroll_year_to_date_adjustment.rbs +66 -0
- data/sig/qube_sync/operations/preferences.rbs +26 -0
- data/sig/qube_sync/operations/price_level.rbs +57 -0
- data/sig/qube_sync/operations/purchase_order.rbs +159 -0
- data/sig/qube_sync/operations/qb_command_exec.rbs +22 -0
- data/sig/qube_sync/operations/receive_payment.rbs +102 -0
- data/sig/qube_sync/operations/receive_payment_to_deposit.rbs +15 -0
- data/sig/qube_sync/operations/sales_order.rbs +153 -0
- data/sig/qube_sync/operations/sales_receipt.rbs +139 -0
- data/sig/qube_sync/operations/sales_rep.rbs +43 -0
- data/sig/qube_sync/operations/sales_tax_code.rbs +49 -0
- data/sig/qube_sync/operations/sales_tax_payable.rbs +16 -0
- data/sig/qube_sync/operations/sales_tax_payment_check.rbs +64 -0
- data/sig/qube_sync/operations/sales_tax_return.rbs +14 -0
- data/sig/qube_sync/operations/sales_tax_return_line.rbs +15 -0
- data/sig/qube_sync/operations/ship_method.rbs +31 -0
- data/sig/qube_sync/operations/special_account.rbs +16 -0
- data/sig/qube_sync/operations/special_item.rbs +17 -0
- data/sig/qube_sync/operations/standard_terms.rbs +34 -0
- data/sig/qube_sync/operations/template.rbs +15 -0
- data/sig/qube_sync/operations/terms.rbs +23 -0
- data/sig/qube_sync/operations/time_report.rbs +26 -0
- data/sig/qube_sync/operations/time_tracking.rbs +57 -0
- data/sig/qube_sync/operations/to_do.rbs +59 -0
- data/sig/qube_sync/operations/transaction.rbs +39 -0
- data/sig/qube_sync/operations/transfer.rbs +47 -0
- data/sig/qube_sync/operations/transfer_inventory.rbs +76 -0
- data/sig/qube_sync/operations/txn.rbs +15 -0
- data/sig/qube_sync/operations/txn_deleted.rbs +17 -0
- data/sig/qube_sync/operations/txn_display.rbs +22 -0
- data/sig/qube_sync/operations/txn_void.rbs +15 -0
- data/sig/qube_sync/operations/types.rbs +434 -0
- data/sig/qube_sync/operations/unit_of_measure_set.rbs +51 -0
- data/sig/qube_sync/operations/vehicle.rbs +43 -0
- data/sig/qube_sync/operations/vehicle_mileage.rbs +38 -0
- data/sig/qube_sync/operations/vendor.rbs +142 -0
- data/sig/qube_sync/operations/vendor_credit.rbs +70 -0
- data/sig/qube_sync/operations/vendor_type.rbs +32 -0
- data/sig/qube_sync/operations/workers_comp_code.rbs +52 -0
- data/sig/qube_sync/operations.rbs +147 -0
- metadata +255 -2
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Generated from operations.json by bin/generate-operations: don't edit.
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module QubeSync
|
|
5
|
+
module Operations
|
|
6
|
+
# QuickBooks form1099 category account mapping operations, reached as `client.form1099_category_account_mapping`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class Form1099CategoryAccountMapping < Base
|
|
9
|
+
# List form1099 category account mappings: GET
|
|
10
|
+
# /connections/{connection_id}/form1099-category-account-mappings
|
|
11
|
+
# (`form1099_category_account_mapping.query`).
|
|
12
|
+
#
|
|
13
|
+
# QuickBooks answers in one webhook.
|
|
14
|
+
#
|
|
15
|
+
# Params, sent as the query string:
|
|
16
|
+
# - `form_type` (String): Added a form type to support Form 1099-NEC and Form 1099-MISC.
|
|
17
|
+
# `form_type` is a property to identify the type of form (MISC/NEC) for which
|
|
18
|
+
# Form1099CategoryAccountMapping query is run. Form type will be MISC if no `form_type` is
|
|
19
|
+
# specified.
|
|
20
|
+
# - `mapping_category` (Array<one of "BOX1", "BOX10", "BOX13", "BOX14", "BOX2", "BOX3",
|
|
21
|
+
# "BOX4", "BOX5", "BOX6", "BOX7", "BOX8", "BOX9">): A mapping category indicates the form
|
|
22
|
+
# 1099 box that one or more accounts is being mapped to. You must specify one of the
|
|
23
|
+
# following enumerated values based on the form type:
|
|
24
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
25
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
26
|
+
# webhook already carries the request's `id`.
|
|
27
|
+
#
|
|
28
|
+
# @param connection_id [String]
|
|
29
|
+
# @param params [Hash] the fields above
|
|
30
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
31
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
32
|
+
# @return [Hash] the queued request
|
|
33
|
+
# @see https://docs.qubesync.com/api-reference/v2/form1099-category-account-mappings/list-form1099-category-account-mappings
|
|
34
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
35
|
+
queue("form1099_category_account_mapping.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Update form1099 category account mapping: PUT
|
|
39
|
+
# /connections/{connection_id}/form1099-category-account-mappings
|
|
40
|
+
# (`form1099_category_account_mapping.update`).
|
|
41
|
+
#
|
|
42
|
+
# QuickBooks answers in one webhook.
|
|
43
|
+
#
|
|
44
|
+
# Params, sent as the JSON body:
|
|
45
|
+
# - `category_account_mapping_mod` (Array<Hash>)
|
|
46
|
+
# - `mapping_account` (Array<Hash>)
|
|
47
|
+
# - `account_ref` (Hash, required): `account_ref` points to an account in the company
|
|
48
|
+
# file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning
|
|
49
|
+
# depends on context: for checks it is the funding account; for ExpenseLineAdd it may be
|
|
50
|
+
# required by accounting preferences; for credit-card transactions it identifies the
|
|
51
|
+
# bank or card account involved.
|
|
52
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
53
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for
|
|
54
|
+
# example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
55
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object.
|
|
56
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
57
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id`
|
|
58
|
+
# are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
59
|
+
# - `force_mapping` (Boolean): In some circumstances, changing the account mapping could
|
|
60
|
+
# result in the displaying of a user dialog in the QuickBooks UI prompting the user to
|
|
61
|
+
# confirm, which would prevent the SDK request from completing. Setting this property to
|
|
62
|
+
# true causes that user dialog to be suppressed.
|
|
63
|
+
# - `mapping_category` (one of "BOX1", "BOX10", "BOX13", "BOX14", "BOX2", "BOX3", "BOX4",
|
|
64
|
+
# "BOX5", "BOX6", "BOX7", "BOX8", "BOX9", required): A mapping category indicates the form
|
|
65
|
+
# 1099 box that one or more accounts is being mapped to. You must specify one of the
|
|
66
|
+
# following enumerated values based on the form type:
|
|
67
|
+
# - `threshold` (Numeric): This is the dollar amount at which the IRS requires you to file
|
|
68
|
+
# the 1099-MISC and 1099-NEC forms. Each box (“Category” in SDK lingo) can have a separate
|
|
69
|
+
# threshold, as established by the IRS. For the latest thresholds, check the website for
|
|
70
|
+
# the Internal Revenue Service, currently at www.irs.gov.
|
|
71
|
+
# - `is_filing1099_misc` (Boolean): This property reports only (it doesn’t set!) the current
|
|
72
|
+
# status of 1099 preferences setting in the company file. The value true indicates that the
|
|
73
|
+
# company file currently has the 1099 filing preference turned on. The value false indicates
|
|
74
|
+
# that the company file isn’t currently set to file 1099-MISC and 1099-NEC forms.
|
|
75
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
76
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
77
|
+
# webhook already carries the request's `id`.
|
|
78
|
+
#
|
|
79
|
+
# @param connection_id [String]
|
|
80
|
+
# @param params [Hash] the fields above
|
|
81
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
82
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
83
|
+
# @return [Hash] the queued request
|
|
84
|
+
# @see https://docs.qubesync.com/api-reference/v2/form1099-category-account-mappings/update-form1099-category-account-mapping
|
|
85
|
+
def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
86
|
+
queue("form1099_category_account_mapping.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# Generated from operations.json by bin/generate-operations: don't edit.
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module QubeSync
|
|
5
|
+
module Operations
|
|
6
|
+
# QuickBooks general detail report operations, reached as `client.general_detail_report`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class GeneralDetailReport < Base
|
|
9
|
+
# List general detail reports: GET /connections/{connection_id}/general-detail-reports
|
|
10
|
+
# (`general_detail_report.query`).
|
|
11
|
+
#
|
|
12
|
+
# QuickBooks answers in one webhook.
|
|
13
|
+
#
|
|
14
|
+
# Params, sent as the query string:
|
|
15
|
+
# - `display_report` (Boolean): Set `display_report` to true to display this report within the
|
|
16
|
+
# QuickBooks UI. (Default is false.) If you want the request to display the report without
|
|
17
|
+
# returning any data to your application, set the responseData attribute to includeNone.
|
|
18
|
+
# - `general_detail_report_type` (one of "1099Detail", "AuditTrail", "BalanceSheetDetail",
|
|
19
|
+
# "CheckDetail", "CustomerBalanceDetail", "DepositDetail", "EstimatesByJob",
|
|
20
|
+
# "ExpenseByVendorDetail", "GeneralLedger", "IncomeByCustomerDetail", "IncomeTaxDetail",
|
|
21
|
+
# "InventoryValuationDetail", "JobProgressInvoicesVsEstimates", "Journal", "MissingChecks",
|
|
22
|
+
# "OpenInvoices", "OpenPOs", "OpenPOsByJob", "OpenSalesOrderByCustomer",
|
|
23
|
+
# "OpenSalesOrderByItem", "PendingSales", "ProfitAndLossDetail", "PurchaseByItemDetail",
|
|
24
|
+
# "PurchaseByVendorDetail", "SalesByCustomerDetail", "SalesByItemDetail",
|
|
25
|
+
# "SalesByRepDetail", "TxnDetailByAccount", "TxnListByCustomer", "TxnListByDate",
|
|
26
|
+
# "TxnListByVendor", "UnbilledCostsByJob", "UnpaidBillsDetail", "VendorBalanceDetail",
|
|
27
|
+
# required): The type of general detail report to return. (If you specify gdrtMissingChecks,
|
|
28
|
+
# you must also specify an account type in the account filter.)
|
|
29
|
+
# - `include_accounts` (one of "All", "InUse"): Indicates whether this report should include
|
|
30
|
+
# all accounts or just those that are currently in use.
|
|
31
|
+
# - `include_column` (Array<one of "Account", "Aging", "Amount", "AmountDifference",
|
|
32
|
+
# "AverageCost", "BilledDate", "BillingStatus", "CalculatedAmount", "Class",
|
|
33
|
+
# "ClearedStatus", "CostPrice", "Credit", "Currency", "Date", "Debit", "DeliveryDate",
|
|
34
|
+
# "DueDate", "EstimateActive", "ExchangeRate", "FOB", "IncomeSubjectToTax", "Invoiced",
|
|
35
|
+
# "Item", "ItemDesc", "LastModifiedBy", "LatestOrPriorState", "Memo", "ModifiedTime",
|
|
36
|
+
# "Name", "NameAccountNumber", "NameAddress", "NameCity", "NameContact", "NameEmail",
|
|
37
|
+
# "NameFax", "NamePhone", "NameState", "NameZip", "OpenBalance", "OriginalAmount",
|
|
38
|
+
# "PONumber", "PaidAmount", "PaidStatus", "PaidThroughDate", "PaymentMethod", "PayrollItem",
|
|
39
|
+
# "PrintStatus", "ProgressAmount", "ProgressPercent", "Quantity", "QuantityAvailable",
|
|
40
|
+
# "QuantityOnHand", "QuantityOnSalesOrder", "ReceivedQuantity", "RefNumber",
|
|
41
|
+
# "RunningBalance", "SSNOrTaxID", "SalesRep", "SalesTaxCode", "SerialOrLotNumber",
|
|
42
|
+
# "ShipDate", "ShipMethod", "SourceName", "SplitAccount", "TaxLine", "TaxTableVersion",
|
|
43
|
+
# "Terms", "TxnID", "TxnNumber", "TxnType", "UnitPrice", "UserEdit", "ValueOnHand",
|
|
44
|
+
# "WageBase", "WageBaseTips">)
|
|
45
|
+
# - `report_account_filter` (Hash): Allows you to query for a specified account type or for
|
|
46
|
+
# specific list elements.
|
|
47
|
+
# Give at most one of: `account_type_filter`, or `list_id`, or `full_name`, or
|
|
48
|
+
# `list_id_with_children`, or `full_name_with_children`.
|
|
49
|
+
# - `account_type_filter` (one of "APAndSalesTax", "APOrCreditCard", "ARAndAP",
|
|
50
|
+
# "AccountsPayable", "AccountsReceivable", "AllowedFor1099", "Asset", "BalanceSheet",
|
|
51
|
+
# "Bank", "BankAndARAndAPAndUF", "BankAndUF", "CostOfSales", "CreditCard", "CurrentAsset",
|
|
52
|
+
# "CurrentAssetAndExpense", "CurrentLiability", "Equity", "EquityAndIncomeAndExpense",
|
|
53
|
+
# "ExpenseAndOtherExpense", "FixedAsset", "IncomeAndExpense", "IncomeAndOtherIncome",
|
|
54
|
+
# "Liability", "LiabilityAndEquity", "LongTermLiability", "NonPosting", "OrdinaryExpense",
|
|
55
|
+
# "OrdinaryIncome", "OrdinaryIncomeAndCOGS", "OrdinaryIncomeAndExpense", "OtherAsset",
|
|
56
|
+
# "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense", "OtherIncome",
|
|
57
|
+
# "OtherIncomeOrExpense"): Allows you to report on a specific account type.
|
|
58
|
+
# - `full_name` (Array<String>)
|
|
59
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
60
|
+
# specified object and its descendants. For names that don’t have children,
|
|
61
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
62
|
+
# - `list_id` (Array<String>)
|
|
63
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
64
|
+
# specified object and its descendants.
|
|
65
|
+
# - `report_basis` (one of "Accrual", "Cash", "None"): If `report_basis` is rbCash, the report
|
|
66
|
+
# bases income and expenses on the dates when money changed hands.rbAccrual, the report
|
|
67
|
+
# bases income on the dates when customers were invoiced and bases expenses on the dates
|
|
68
|
+
# when bills were entered.rbNone, the report uses the default `report_basis`, which is
|
|
69
|
+
# either the QuickBooks Preference setting or the QuickBooks default for a given type of
|
|
70
|
+
# report.
|
|
71
|
+
# - `report_class_filter` (Hash): Allows you to query for a specified class. Classes can be
|
|
72
|
+
# used to separate transactions into meaningful categories. (For example, transactions could
|
|
73
|
+
# be classified according to department, business location, or type of work.) In QuickBooks,
|
|
74
|
+
# class tracking is off by default.
|
|
75
|
+
# Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
|
|
76
|
+
# `full_name_with_children`.
|
|
77
|
+
# - `full_name` (Array<String>)
|
|
78
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
79
|
+
# specified object and its descendants. For names that don’t have children,
|
|
80
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
81
|
+
# - `list_id` (Array<String>)
|
|
82
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
83
|
+
# specified object and its descendants.
|
|
84
|
+
# - `report_date_macro` (one of "All", "LastMonth", "LastMonthToDate", "LastQuarter",
|
|
85
|
+
# "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear", "LastYearToDate",
|
|
86
|
+
# "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear", "ThisMonth",
|
|
87
|
+
# "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek", "ThisWeekToDate",
|
|
88
|
+
# "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period covered by this
|
|
89
|
+
# report. Choose at most one of: `report_period`, or `report_date_macro`.
|
|
90
|
+
# - `report_detail_level_filter` (one of "All", "AllExceptSummary", "SummaryOnly"): The level
|
|
91
|
+
# of detail to include in the report.
|
|
92
|
+
# - `report_entity_filter` (Hash): Allows you to query for a specified name type (customer,
|
|
93
|
+
# employee, vendor, or other) or query for specific list elements.
|
|
94
|
+
# Give at most one of: `entity_type_filter`, or `list_id`, or `full_name`, or
|
|
95
|
+
# `list_id_with_children`, or `full_name_with_children`.
|
|
96
|
+
# - `entity_type_filter` (one of "Customer", "Employee", "OtherName", "Vendor"): Allows you
|
|
97
|
+
# to report on a specific name type.
|
|
98
|
+
# - `full_name` (Array<String>)
|
|
99
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
100
|
+
# specified object and its descendants. For names that don’t have children,
|
|
101
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
102
|
+
# - `list_id` (Array<String>)
|
|
103
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
104
|
+
# specified object and its descendants.
|
|
105
|
+
# - `report_item_filter` (Hash): Allows you to query for a specified item type (for example,
|
|
106
|
+
# discount, inventory, or non-inventory) or query for specific list elements.
|
|
107
|
+
# Give at most one of: `item_type_filter`, or `list_id`, or `full_name`, or
|
|
108
|
+
# `list_id_with_children`, or `full_name_with_children`.
|
|
109
|
+
# - `full_name` (Array<String>)
|
|
110
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
111
|
+
# specified object and its descendants. For names that don’t have children,
|
|
112
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
113
|
+
# - `item_type_filter` (one of "AllExceptFixedAsset", "Assembly", "Discount", "FixedAsset",
|
|
114
|
+
# "Inventory", "InventoryAndAssembly", "NonInventory", "OtherCharge", "Payment", "Sales",
|
|
115
|
+
# "SalesTax", "Service"): Allows you to report on a specific item type.
|
|
116
|
+
# - `list_id` (Array<String>)
|
|
117
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
118
|
+
# specified object and its descendants.
|
|
119
|
+
# - `report_modified_date_range_filter` (Hash): Returns reports that were modified between
|
|
120
|
+
# these two dates (inclusive). The range of acceptable dates for both
|
|
121
|
+
# `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to
|
|
122
|
+
# 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). Choose at most one of:
|
|
123
|
+
# `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
124
|
+
# - `from_report_modified_date` (String): Selects information from this date and later. The
|
|
125
|
+
# range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
|
|
126
|
+
# (2038-01-18T19:14:07-08:00 PST).
|
|
127
|
+
# - `to_report_modified_date` (String): Selects information created on this date or earlier.
|
|
128
|
+
# The range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
|
|
129
|
+
# (2038-01-18T19:14:07-08:00 PST).
|
|
130
|
+
# - `report_modified_date_range_macro` (one of "All", "LastMonth", "LastMonthToDate",
|
|
131
|
+
# "LastQuarter", "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear",
|
|
132
|
+
# "LastYearToDate", "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear",
|
|
133
|
+
# "ThisMonth", "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek",
|
|
134
|
+
# "ThisWeekToDate", "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period
|
|
135
|
+
# covered by this report. Choose at most one of: `report_modified_date_range_filter`, or
|
|
136
|
+
# `report_modified_date_range_macro`.
|
|
137
|
+
# - `report_open_balance_as_of` (one of "ReportEndDate", "Today"): The report will return open
|
|
138
|
+
# balance information up to the `report_open_balance_as_of` date.
|
|
139
|
+
# - `report_period` (Hash): If you omit both `to_report_date` and `from_report_date`, the
|
|
140
|
+
# report will cover the current fiscal year to date. Choose at most one of: `report_period`,
|
|
141
|
+
# or `report_date_macro`.
|
|
142
|
+
# - `from_report_date` (String): Selects information from this date and later. The range of
|
|
143
|
+
# acceptable `from_report_date` and `to_report_date` values depends on how the report
|
|
144
|
+
# dates are determined. If the report dates are based on the dates of transactions, the
|
|
145
|
+
# range is 01/01/1901 to 12/31/9999.
|
|
146
|
+
# - `to_report_date` (String): Selects information created on this date or earlier. The
|
|
147
|
+
# range of acceptable `to_report_date` and `from_report_date` values depends on how the
|
|
148
|
+
# report dates are determined. If the report dates are based on the dates of transactions,
|
|
149
|
+
# the range is 01/01/1901 to 12/31/9999.
|
|
150
|
+
# - `report_posting_status_filter` (one of "Either", "NonPosting", "Posting"): Allows you to
|
|
151
|
+
# query for posting reports, non-posting reports, or reports that are either one.
|
|
152
|
+
# - `report_txn_type_filter` (Hash): Allows you to report on specific transaction types (for
|
|
153
|
+
# example, charge, check, deposit, or estimate).
|
|
154
|
+
# - `txn_type_filter` (Array<one of "ARRefundCreditCard", "All", "Bill", "BillPaymentCheck",
|
|
155
|
+
# "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check", "CreditCardCharge",
|
|
156
|
+
# "CreditCardCredit", "CreditMemo", "Deposit", "Estimate", "InventoryAdjustment",
|
|
157
|
+
# "Invoice", "ItemReceipt", "JournalEntry", "LiabilityAdjustment", "Paycheck",
|
|
158
|
+
# "PayrollLiabilityCheck", "PurchaseOrder", "ReceivePayment", "SalesOrder",
|
|
159
|
+
# "SalesReceipt", "SalesTaxPaymentCheck", "Transfer", "VendorCredit", "YTDAdjustment">,
|
|
160
|
+
# required)
|
|
161
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
162
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
163
|
+
# webhook already carries the request's `id`.
|
|
164
|
+
# - `summarize_rows_by` (one of "Account", "BalanceSheet", "Class", "Customer",
|
|
165
|
+
# "CustomerType", "Day", "Employee", "FourWeek", "HalfMonth", "IncomeStatement",
|
|
166
|
+
# "ItemDetail", "ItemType", "Month", "Payee", "PaymentMethod", "PayrollItemDetail",
|
|
167
|
+
# "PayrollYtdDetail", "Quarter", "SalesRep", "SalesTaxCode", "ShipMethod", "TaxLine",
|
|
168
|
+
# "Terms", "TotalOnly", "TwoWeek", "Vendor", "VendorType", "Week", "Year"):
|
|
169
|
+
# `summarize_rows_by` (along with IncludeColumnList, in most cases) determines what data is
|
|
170
|
+
# calculated for this report and controls how the rows are organized and labeled. For
|
|
171
|
+
# example, if you set the value to srbAccount, the report’s row labels might be “Checking,”
|
|
172
|
+
# “Savings,” and so on.
|
|
173
|
+
#
|
|
174
|
+
# @param connection_id [String]
|
|
175
|
+
# @param params [Hash] the fields above
|
|
176
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
177
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
178
|
+
# @return [Hash] the queued request
|
|
179
|
+
# @see https://docs.qubesync.com/api-reference/v2/general-detail-reports/list-general-detail-reports
|
|
180
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
181
|
+
queue("general_detail_report.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
end
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# Generated from operations.json by bin/generate-operations: don't edit.
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module QubeSync
|
|
5
|
+
module Operations
|
|
6
|
+
# QuickBooks general summary report operations, reached as `client.general_summary_report`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class GeneralSummaryReport < Base
|
|
9
|
+
# List general summary reports: GET /connections/{connection_id}/general-summary-reports
|
|
10
|
+
# (`general_summary_report.query`).
|
|
11
|
+
#
|
|
12
|
+
# QuickBooks answers in one webhook.
|
|
13
|
+
#
|
|
14
|
+
# Params, sent as the query string:
|
|
15
|
+
# - `display_report` (Boolean): Set `display_report` to true to display this report within the
|
|
16
|
+
# QuickBooks UI. (Default is false.) If you want the request to display the report without
|
|
17
|
+
# returning any data to your application, set the responseData attribute to includeNone.
|
|
18
|
+
# - `general_summary_report_type` (one of "BalanceSheetByClass", "BalanceSheetPrevYearComp",
|
|
19
|
+
# "BalanceSheetStandard", "BalanceSheetSummary", "CustomerBalanceSummary",
|
|
20
|
+
# "ExpenseByVendorSummary", "IncomeByCustomerSummary", "IncomeTaxSummary",
|
|
21
|
+
# "InventoryStockStatusByItem", "InventoryStockStatusByVendor", "InventoryValuationSummary",
|
|
22
|
+
# "InventoryValuationSummaryBySite", "LotNumberInStockBySite", "PhysicalInventoryWorksheet",
|
|
23
|
+
# "ProfitAndLossByClass", "ProfitAndLossByJob", "ProfitAndLossPrevYearComp",
|
|
24
|
+
# "ProfitAndLossStandard", "ProfitAndLossYTDComp", "PurchaseByItemSummary",
|
|
25
|
+
# "PurchaseByVendorSummary", "SalesByCustomerSummary", "SalesByItemSummary",
|
|
26
|
+
# "SalesByRepSummary", "SalesTaxLiability", "SalesTaxRevenueSummary",
|
|
27
|
+
# "SerialNumberInStockBySite", "TrialBalance", "VendorBalanceSummary", required): The type
|
|
28
|
+
# of general summary report being queried. The report types listed below map almost directly
|
|
29
|
+
# to named reports in QuickBooks.
|
|
30
|
+
# - `include_subcolumns` (Boolean): The default value is false, which means that the report
|
|
31
|
+
# won’t include any subcolumn information. To include all available types of subcolumns for
|
|
32
|
+
# this report, set `include_subcolumns` to true. The SDK won’t return subcolumn information
|
|
33
|
+
# for data that can be easily computed. (For example, the SDK doesn’t return the “percent of
|
|
34
|
+
# row” column.)
|
|
35
|
+
# - `report_account_filter` (Hash): Allows you to query for a specified account type or for
|
|
36
|
+
# specific list elements.
|
|
37
|
+
# Give at most one of: `account_type_filter`, or `list_id`, or `full_name`, or
|
|
38
|
+
# `list_id_with_children`, or `full_name_with_children`.
|
|
39
|
+
# - `account_type_filter` (one of "APAndSalesTax", "APOrCreditCard", "ARAndAP",
|
|
40
|
+
# "AccountsPayable", "AccountsReceivable", "AllowedFor1099", "Asset", "BalanceSheet",
|
|
41
|
+
# "Bank", "BankAndARAndAPAndUF", "BankAndUF", "CostOfSales", "CreditCard", "CurrentAsset",
|
|
42
|
+
# "CurrentAssetAndExpense", "CurrentLiability", "Equity", "EquityAndIncomeAndExpense",
|
|
43
|
+
# "ExpenseAndOtherExpense", "FixedAsset", "IncomeAndExpense", "IncomeAndOtherIncome",
|
|
44
|
+
# "Liability", "LiabilityAndEquity", "LongTermLiability", "NonPosting", "OrdinaryExpense",
|
|
45
|
+
# "OrdinaryIncome", "OrdinaryIncomeAndCOGS", "OrdinaryIncomeAndExpense", "OtherAsset",
|
|
46
|
+
# "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense", "OtherIncome",
|
|
47
|
+
# "OtherIncomeOrExpense"): Allows you to report on a specific account type.
|
|
48
|
+
# - `full_name` (Array<String>)
|
|
49
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
50
|
+
# specified object and its descendants. For names that don’t have children,
|
|
51
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
52
|
+
# - `list_id` (Array<String>)
|
|
53
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
54
|
+
# specified object and its descendants.
|
|
55
|
+
# - `report_basis` (one of "Accrual", "Cash", "None"): If `report_basis` is rbCash, the report
|
|
56
|
+
# bases income and expenses on the dates when money changed hands.rbAccrual, the report
|
|
57
|
+
# bases income on the dates when customers were invoiced and bases expenses on the dates
|
|
58
|
+
# when bills were entered.rbNone, the report uses the default `report_basis`, which is
|
|
59
|
+
# either the QuickBooks Preference setting or the QuickBooks default for a given type of
|
|
60
|
+
# report.
|
|
61
|
+
# - `report_calendar` (one of "CalendarYear", "FiscalYear", "TaxYear"): Specifies the type of
|
|
62
|
+
# year that will be used for this report.
|
|
63
|
+
# - `report_class_filter` (Hash): Allows you to query for a specified class. Classes can be
|
|
64
|
+
# used to separate transactions into meaningful categories. (For example, transactions could
|
|
65
|
+
# be classified according to department, business location, or type of work.) In QuickBooks,
|
|
66
|
+
# class tracking is off by default.
|
|
67
|
+
# Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
|
|
68
|
+
# `full_name_with_children`.
|
|
69
|
+
# - `full_name` (Array<String>)
|
|
70
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
71
|
+
# specified object and its descendants. For names that don’t have children,
|
|
72
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
73
|
+
# - `list_id` (Array<String>)
|
|
74
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
75
|
+
# specified object and its descendants.
|
|
76
|
+
# - `report_date_macro` (one of "All", "LastMonth", "LastMonthToDate", "LastQuarter",
|
|
77
|
+
# "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear", "LastYearToDate",
|
|
78
|
+
# "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear", "ThisMonth",
|
|
79
|
+
# "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek", "ThisWeekToDate",
|
|
80
|
+
# "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period covered by this
|
|
81
|
+
# report. Choose at most one of: `report_period`, or `report_date_macro`.
|
|
82
|
+
# - `report_detail_level_filter` (one of "All", "AllExceptSummary", "SummaryOnly"): The level
|
|
83
|
+
# of detail to include in the report.
|
|
84
|
+
# - `report_entity_filter` (Hash): Allows you to query for a specified name type (customer,
|
|
85
|
+
# employee, vendor, or other) or query for specific list elements.
|
|
86
|
+
# Give at most one of: `entity_type_filter`, or `list_id`, or `full_name`, or
|
|
87
|
+
# `list_id_with_children`, or `full_name_with_children`.
|
|
88
|
+
# - `entity_type_filter` (one of "Customer", "Employee", "OtherName", "Vendor"): Allows you
|
|
89
|
+
# to report on a specific name type.
|
|
90
|
+
# - `full_name` (Array<String>)
|
|
91
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
92
|
+
# specified object and its descendants. For names that don’t have children,
|
|
93
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
94
|
+
# - `list_id` (Array<String>)
|
|
95
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
96
|
+
# specified object and its descendants.
|
|
97
|
+
# - `report_item_filter` (Hash): Allows you to query for a specified item type (for example,
|
|
98
|
+
# discount, inventory, or non-inventory) or query for specific list elements.
|
|
99
|
+
# Give at most one of: `item_type_filter`, or `list_id`, or `full_name`, or
|
|
100
|
+
# `list_id_with_children`, or `full_name_with_children`.
|
|
101
|
+
# - `full_name` (Array<String>)
|
|
102
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
103
|
+
# specified object and its descendants. For names that don’t have children,
|
|
104
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
105
|
+
# - `item_type_filter` (one of "AllExceptFixedAsset", "Assembly", "Discount", "FixedAsset",
|
|
106
|
+
# "Inventory", "InventoryAndAssembly", "NonInventory", "OtherCharge", "Payment", "Sales",
|
|
107
|
+
# "SalesTax", "Service"): Allows you to report on a specific item type.
|
|
108
|
+
# - `list_id` (Array<String>)
|
|
109
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
110
|
+
# specified object and its descendants.
|
|
111
|
+
# - `report_modified_date_range_filter` (Hash): Returns reports that were modified between
|
|
112
|
+
# these two dates (inclusive). The range of acceptable dates for both
|
|
113
|
+
# `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to
|
|
114
|
+
# 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). Choose at most one of:
|
|
115
|
+
# `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
|
|
116
|
+
# - `from_report_modified_date` (String): Selects information from this date and later. The
|
|
117
|
+
# range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
|
|
118
|
+
# (2038-01-18T19:14:07-08:00 PST).
|
|
119
|
+
# - `to_report_modified_date` (String): Selects information created on this date or earlier.
|
|
120
|
+
# The range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
|
|
121
|
+
# (2038-01-18T19:14:07-08:00 PST).
|
|
122
|
+
# - `report_modified_date_range_macro` (one of "All", "LastMonth", "LastMonthToDate",
|
|
123
|
+
# "LastQuarter", "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear",
|
|
124
|
+
# "LastYearToDate", "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear",
|
|
125
|
+
# "ThisMonth", "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek",
|
|
126
|
+
# "ThisWeekToDate", "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period
|
|
127
|
+
# covered by this report. Choose at most one of: `report_modified_date_range_filter`, or
|
|
128
|
+
# `report_modified_date_range_macro`.
|
|
129
|
+
# - `report_period` (Hash): If you omit both `to_report_date` and `from_report_date`, the
|
|
130
|
+
# report will cover the current fiscal year to date. Choose at most one of: `report_period`,
|
|
131
|
+
# or `report_date_macro`.
|
|
132
|
+
# - `from_report_date` (String): Selects information from this date and later. The range of
|
|
133
|
+
# acceptable `from_report_date` and `to_report_date` values depends on how the report
|
|
134
|
+
# dates are determined. If the report dates are based on the dates of transactions, the
|
|
135
|
+
# range is 01/01/1901 to 12/31/9999.
|
|
136
|
+
# - `to_report_date` (String): Selects information created on this date or earlier. The
|
|
137
|
+
# range of acceptable `to_report_date` and `from_report_date` values depends on how the
|
|
138
|
+
# report dates are determined. If the report dates are based on the dates of transactions,
|
|
139
|
+
# the range is 01/01/1901 to 12/31/9999.
|
|
140
|
+
# - `report_posting_status_filter` (one of "Either", "NonPosting", "Posting"): Allows you to
|
|
141
|
+
# query for posting reports, non-posting reports, or reports that are either one.
|
|
142
|
+
# - `report_txn_type_filter` (Hash): Allows you to report on specific transaction types (for
|
|
143
|
+
# example, charge, check, deposit, or estimate).
|
|
144
|
+
# - `txn_type_filter` (Array<one of "ARRefundCreditCard", "All", "Bill", "BillPaymentCheck",
|
|
145
|
+
# "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check", "CreditCardCharge",
|
|
146
|
+
# "CreditCardCredit", "CreditMemo", "Deposit", "Estimate", "InventoryAdjustment",
|
|
147
|
+
# "Invoice", "ItemReceipt", "JournalEntry", "LiabilityAdjustment", "Paycheck",
|
|
148
|
+
# "PayrollLiabilityCheck", "PurchaseOrder", "ReceivePayment", "SalesOrder",
|
|
149
|
+
# "SalesReceipt", "SalesTaxPaymentCheck", "Transfer", "VendorCredit", "YTDAdjustment">,
|
|
150
|
+
# required)
|
|
151
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
152
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
153
|
+
# webhook already carries the request's `id`.
|
|
154
|
+
# - `return_columns` (one of "ActiveOnly", "All", "NonZero"): Specifies whether you want the
|
|
155
|
+
# report to include only columns with active information, only columns with nonzero values,
|
|
156
|
+
# or all columns regardless of their content or active status.
|
|
157
|
+
# - `return_rows` (one of "ActiveOnly", "All", "NonZero"): Specifies whether you want the
|
|
158
|
+
# report to include only rows with active information, only rows with nonzero values, or all
|
|
159
|
+
# rows regardless of their content or active status.
|
|
160
|
+
# - `summarize_columns_by` (one of "Account", "BalanceSheet", "Class", "Customer",
|
|
161
|
+
# "CustomerType", "Day", "Employee", "FourWeek", "HalfMonth", "IncomeStatement",
|
|
162
|
+
# "ItemDetail", "ItemType", "Month", "Payee", "PaymentMethod", "PayrollItemDetail",
|
|
163
|
+
# "PayrollYtdDetail", "Quarter", "SalesRep", "SalesTaxCode", "ShipMethod", "Terms",
|
|
164
|
+
# "TotalOnly", "TwoWeek", "Vendor", "VendorType", "Week", "Year"): `summarize_columns_by`
|
|
165
|
+
# determines which data the report calculates and how the columns will be labeled across the
|
|
166
|
+
# top of the report. For example, if you set the value to scbTwoWeek, the report’s column
|
|
167
|
+
# labels might be “Feb 10-23, 02,” “Feb 24-Mar9, 02,” and so on.
|
|
168
|
+
#
|
|
169
|
+
# @param connection_id [String]
|
|
170
|
+
# @param params [Hash] the fields above
|
|
171
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
172
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
173
|
+
# @return [Hash] the queued request
|
|
174
|
+
# @see https://docs.qubesync.com/api-reference/v2/general-summary-reports/list-general-summary-reports
|
|
175
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
176
|
+
queue("general_summary_report.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Generated from operations.json by bin/generate-operations: don't edit.
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module QubeSync
|
|
5
|
+
module Operations
|
|
6
|
+
# QuickBooks host operations, reached as `client.host`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class Host < Base
|
|
9
|
+
# List hosts: GET /connections/{connection_id}/hosts (`host.query`).
|
|
10
|
+
#
|
|
11
|
+
# QuickBooks answers in one webhook.
|
|
12
|
+
#
|
|
13
|
+
# Params, sent as the query string:
|
|
14
|
+
# - `include_list_meta_data` (Hash): Use this aggregate if you want the query to return list
|
|
15
|
+
# capacity metadata for each object type in QuickBooks.
|
|
16
|
+
# - `include_max_capacity` (Boolean, required): Specify the value “true” to return max list
|
|
17
|
+
# limits for each object type, or “false” to not return these in the query response. By
|
|
18
|
+
# default, this is “false” for HostQuery.
|
|
19
|
+
# - `include_ret_element` (Array<one of "Country", "IsAutomaticLogin", "ListMetaData",
|
|
20
|
+
# "MajorVersion", "MinorVersion", "ProductName", "QBFileMode", "SupportedQBXMLVersion">)
|
|
21
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
22
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
23
|
+
# webhook already carries the request's `id`.
|
|
24
|
+
#
|
|
25
|
+
# @param connection_id [String]
|
|
26
|
+
# @param params [Hash] the fields above
|
|
27
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
28
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
29
|
+
# @return [Hash] the queued request
|
|
30
|
+
# @see https://docs.qubesync.com/api-reference/v2/hosts/list-hosts
|
|
31
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
32
|
+
queue("host.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|