conductor-node 14.24.3 → 15.0.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 +89 -0
- package/package.json +1 -1
- package/resources/qbd/accounts.d.mts +17 -9
- package/resources/qbd/accounts.d.mts.map +1 -1
- package/resources/qbd/accounts.d.ts +17 -9
- package/resources/qbd/accounts.d.ts.map +1 -1
- package/resources/qbd/bill-credit-card-payments.d.mts +7 -4
- package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -1
- package/resources/qbd/bill-credit-card-payments.d.ts +7 -4
- package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
- package/resources/qbd/classes.d.mts +19 -9
- package/resources/qbd/classes.d.mts.map +1 -1
- package/resources/qbd/classes.d.ts +19 -9
- package/resources/qbd/classes.d.ts.map +1 -1
- package/resources/qbd/currencies.d.mts +9 -9
- package/resources/qbd/currencies.d.mts.map +1 -1
- package/resources/qbd/currencies.d.ts +9 -9
- package/resources/qbd/currencies.d.ts.map +1 -1
- package/resources/qbd/customer-types.d.mts +19 -9
- package/resources/qbd/customer-types.d.mts.map +1 -1
- package/resources/qbd/customer-types.d.ts +19 -9
- package/resources/qbd/customer-types.d.ts.map +1 -1
- package/resources/qbd/customers.d.mts +15 -4
- package/resources/qbd/customers.d.mts.map +1 -1
- package/resources/qbd/customers.d.ts +15 -4
- package/resources/qbd/customers.d.ts.map +1 -1
- package/resources/qbd/date-driven-terms.d.mts +19 -9
- package/resources/qbd/date-driven-terms.d.mts.map +1 -1
- package/resources/qbd/date-driven-terms.d.ts +19 -9
- package/resources/qbd/date-driven-terms.d.ts.map +1 -1
- package/resources/qbd/discount-items.d.mts +15 -4
- package/resources/qbd/discount-items.d.mts.map +1 -1
- package/resources/qbd/discount-items.d.ts +15 -4
- package/resources/qbd/discount-items.d.ts.map +1 -1
- package/resources/qbd/employees.d.mts +19 -9
- package/resources/qbd/employees.d.mts.map +1 -1
- package/resources/qbd/employees.d.ts +19 -9
- package/resources/qbd/employees.d.ts.map +1 -1
- package/resources/qbd/inventory-adjustments.d.mts +2 -5
- package/resources/qbd/inventory-adjustments.d.mts.map +1 -1
- package/resources/qbd/inventory-adjustments.d.ts +2 -5
- package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
- package/resources/qbd/inventory-assembly-items.d.mts +15 -4
- package/resources/qbd/inventory-assembly-items.d.mts.map +1 -1
- package/resources/qbd/inventory-assembly-items.d.ts +15 -4
- package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
- package/resources/qbd/inventory-items.d.mts +15 -4
- package/resources/qbd/inventory-items.d.mts.map +1 -1
- package/resources/qbd/inventory-items.d.ts +15 -4
- package/resources/qbd/inventory-items.d.ts.map +1 -1
- package/resources/qbd/inventory-sites.d.mts +7 -4
- package/resources/qbd/inventory-sites.d.mts.map +1 -1
- package/resources/qbd/inventory-sites.d.ts +7 -4
- package/resources/qbd/inventory-sites.d.ts.map +1 -1
- package/resources/qbd/item-groups.d.mts +15 -4
- package/resources/qbd/item-groups.d.mts.map +1 -1
- package/resources/qbd/item-groups.d.ts +15 -4
- package/resources/qbd/item-groups.d.ts.map +1 -1
- package/resources/qbd/non-inventory-items.d.mts +15 -4
- package/resources/qbd/non-inventory-items.d.mts.map +1 -1
- package/resources/qbd/non-inventory-items.d.ts +15 -4
- package/resources/qbd/non-inventory-items.d.ts.map +1 -1
- package/resources/qbd/other-charge-items.d.mts +15 -4
- package/resources/qbd/other-charge-items.d.mts.map +1 -1
- package/resources/qbd/other-charge-items.d.ts +15 -4
- package/resources/qbd/other-charge-items.d.ts.map +1 -1
- package/resources/qbd/other-names.d.mts +19 -9
- package/resources/qbd/other-names.d.mts.map +1 -1
- package/resources/qbd/other-names.d.ts +19 -9
- package/resources/qbd/other-names.d.ts.map +1 -1
- package/resources/qbd/payment-methods.d.mts +19 -9
- package/resources/qbd/payment-methods.d.mts.map +1 -1
- package/resources/qbd/payment-methods.d.ts +19 -9
- package/resources/qbd/payment-methods.d.ts.map +1 -1
- package/resources/qbd/payroll-wage-items.d.mts +15 -4
- package/resources/qbd/payroll-wage-items.d.mts.map +1 -1
- package/resources/qbd/payroll-wage-items.d.ts +15 -4
- package/resources/qbd/payroll-wage-items.d.ts.map +1 -1
- package/resources/qbd/price-levels.d.mts +22 -11
- package/resources/qbd/price-levels.d.mts.map +1 -1
- package/resources/qbd/price-levels.d.ts +22 -11
- package/resources/qbd/price-levels.d.ts.map +1 -1
- package/resources/qbd/sales-representatives.d.mts +9 -9
- package/resources/qbd/sales-representatives.d.mts.map +1 -1
- package/resources/qbd/sales-representatives.d.ts +9 -9
- package/resources/qbd/sales-representatives.d.ts.map +1 -1
- package/resources/qbd/sales-tax-codes.d.mts +19 -9
- package/resources/qbd/sales-tax-codes.d.mts.map +1 -1
- package/resources/qbd/sales-tax-codes.d.ts +19 -9
- package/resources/qbd/sales-tax-codes.d.ts.map +1 -1
- package/resources/qbd/sales-tax-group-items.d.mts +15 -4
- package/resources/qbd/sales-tax-group-items.d.mts.map +1 -1
- package/resources/qbd/sales-tax-group-items.d.ts +15 -4
- package/resources/qbd/sales-tax-group-items.d.ts.map +1 -1
- package/resources/qbd/sales-tax-items.d.mts +15 -4
- package/resources/qbd/sales-tax-items.d.mts.map +1 -1
- package/resources/qbd/sales-tax-items.d.ts +15 -4
- package/resources/qbd/sales-tax-items.d.ts.map +1 -1
- package/resources/qbd/service-items.d.mts +15 -4
- package/resources/qbd/service-items.d.mts.map +1 -1
- package/resources/qbd/service-items.d.ts +15 -4
- package/resources/qbd/service-items.d.ts.map +1 -1
- package/resources/qbd/shipping-methods.d.mts +19 -9
- package/resources/qbd/shipping-methods.d.mts.map +1 -1
- package/resources/qbd/shipping-methods.d.ts +19 -9
- package/resources/qbd/shipping-methods.d.ts.map +1 -1
- package/resources/qbd/standard-terms.d.mts +19 -9
- package/resources/qbd/standard-terms.d.mts.map +1 -1
- package/resources/qbd/standard-terms.d.ts +19 -9
- package/resources/qbd/standard-terms.d.ts.map +1 -1
- package/resources/qbd/subtotal-items.d.mts +15 -4
- package/resources/qbd/subtotal-items.d.mts.map +1 -1
- package/resources/qbd/subtotal-items.d.ts +15 -4
- package/resources/qbd/subtotal-items.d.ts.map +1 -1
- package/resources/qbd/unit-of-measure-sets.d.mts +9 -9
- package/resources/qbd/unit-of-measure-sets.d.mts.map +1 -1
- package/resources/qbd/unit-of-measure-sets.d.ts +9 -9
- package/resources/qbd/unit-of-measure-sets.d.ts.map +1 -1
- package/resources/qbd/vendors.d.mts +15 -4
- package/resources/qbd/vendors.d.mts.map +1 -1
- package/resources/qbd/vendors.d.ts +15 -4
- package/resources/qbd/vendors.d.ts.map +1 -1
- package/src/resources/qbd/accounts.ts +17 -9
- package/src/resources/qbd/bill-credit-card-payments.ts +7 -4
- package/src/resources/qbd/classes.ts +19 -9
- package/src/resources/qbd/currencies.ts +9 -9
- package/src/resources/qbd/customer-types.ts +19 -9
- package/src/resources/qbd/customers.ts +15 -4
- package/src/resources/qbd/date-driven-terms.ts +19 -9
- package/src/resources/qbd/discount-items.ts +15 -4
- package/src/resources/qbd/employees.ts +19 -9
- package/src/resources/qbd/inventory-adjustments.ts +2 -5
- package/src/resources/qbd/inventory-assembly-items.ts +15 -4
- package/src/resources/qbd/inventory-items.ts +15 -4
- package/src/resources/qbd/inventory-sites.ts +7 -4
- package/src/resources/qbd/item-groups.ts +15 -4
- package/src/resources/qbd/non-inventory-items.ts +15 -4
- package/src/resources/qbd/other-charge-items.ts +15 -4
- package/src/resources/qbd/other-names.ts +19 -9
- package/src/resources/qbd/payment-methods.ts +19 -9
- package/src/resources/qbd/payroll-wage-items.ts +15 -4
- package/src/resources/qbd/price-levels.ts +22 -11
- package/src/resources/qbd/sales-representatives.ts +9 -9
- package/src/resources/qbd/sales-tax-codes.ts +19 -9
- package/src/resources/qbd/sales-tax-group-items.ts +15 -4
- package/src/resources/qbd/sales-tax-items.ts +15 -4
- package/src/resources/qbd/service-items.ts +15 -4
- package/src/resources/qbd/shipping-methods.ts +19 -9
- package/src/resources/qbd/standard-terms.ts +19 -9
- package/src/resources/qbd/subtotal-items.ts +15 -4
- package/src/resources/qbd/unit-of-measure-sets.ts +9 -9
- package/src/resources/qbd/vendors.ts +15 -4
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -261,13 +261,12 @@ export interface DateDrivenTermListParams {
|
|
|
261
261
|
* Query param: The maximum number of objects to return.
|
|
262
262
|
*
|
|
263
263
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
264
|
-
* date-driven terms
|
|
265
|
-
*
|
|
266
|
-
*
|
|
264
|
+
* date-driven terms, so this parameter only limits the response size. To page
|
|
265
|
+
* through date-driven terms by name, see
|
|
266
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
267
267
|
*
|
|
268
268
|
* When this parameter is omitted, the endpoint returns all date-driven terms
|
|
269
|
-
* without limit, unlike paginated endpoints which default to 150 records.
|
|
270
|
-
* acceptable because date-driven terms typically have low record counts.
|
|
269
|
+
* without limit, unlike paginated endpoints which default to 150 records.
|
|
271
270
|
*/
|
|
272
271
|
limit?: number;
|
|
273
272
|
|
|
@@ -290,8 +289,14 @@ export interface DateDrivenTermListParams {
|
|
|
290
289
|
nameEndsWith?: string;
|
|
291
290
|
|
|
292
291
|
/**
|
|
293
|
-
* Query param: Filter for date-driven terms whose `name`
|
|
294
|
-
*
|
|
292
|
+
* Query param: Filter for date-driven terms whose `name` sorts at or after this
|
|
293
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
294
|
+
* punctuation first, then digits, then letters.
|
|
295
|
+
*
|
|
296
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns date-driven terms sorted
|
|
297
|
+
* by `name` in that order; without either, the order is not guaranteed. To page
|
|
298
|
+
* through date-driven terms by name, see
|
|
299
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
295
300
|
*
|
|
296
301
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
297
302
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -321,8 +326,13 @@ export interface DateDrivenTermListParams {
|
|
|
321
326
|
nameStartsWith?: string;
|
|
322
327
|
|
|
323
328
|
/**
|
|
324
|
-
* Query param: Filter for date-driven terms whose `name`
|
|
325
|
-
*
|
|
329
|
+
* Query param: Filter for date-driven terms whose `name` sorts at or before this
|
|
330
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
331
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
332
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
333
|
+
*
|
|
334
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns date-driven terms sorted
|
|
335
|
+
* by `name` in that order; without either, the order is not guaranteed.
|
|
326
336
|
*
|
|
327
337
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
328
338
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -727,8 +727,14 @@ export interface DiscountItemListParams extends CursorPageParams {
|
|
|
727
727
|
nameEndsWith?: string;
|
|
728
728
|
|
|
729
729
|
/**
|
|
730
|
-
* Query param: Filter for discount items whose `
|
|
731
|
-
*
|
|
730
|
+
* Query param: Filter for discount items whose `fullName` sorts at or after this
|
|
731
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
732
|
+
* punctuation first, then digits, then letters.
|
|
733
|
+
*
|
|
734
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns discount items sorted by
|
|
735
|
+
* `fullName` in that order; without either, the order is not guaranteed. To page
|
|
736
|
+
* through discount items by name, see
|
|
737
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
732
738
|
*
|
|
733
739
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
734
740
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -745,8 +751,13 @@ export interface DiscountItemListParams extends CursorPageParams {
|
|
|
745
751
|
nameStartsWith?: string;
|
|
746
752
|
|
|
747
753
|
/**
|
|
748
|
-
* Query param: Filter for discount items whose `
|
|
749
|
-
*
|
|
754
|
+
* Query param: Filter for discount items whose `fullName` sorts at or before this
|
|
755
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
756
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
757
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
758
|
+
*
|
|
759
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns discount items sorted by
|
|
760
|
+
* `fullName` in that order; without either, the order is not guaranteed.
|
|
750
761
|
*
|
|
751
762
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
752
763
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -2405,13 +2405,12 @@ export interface EmployeeListParams {
|
|
|
2405
2405
|
* Query param: The maximum number of objects to return.
|
|
2406
2406
|
*
|
|
2407
2407
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
2408
|
-
* employees
|
|
2409
|
-
*
|
|
2410
|
-
*
|
|
2408
|
+
* employees, so this parameter only limits the response size. To page through
|
|
2409
|
+
* employees by name, see
|
|
2410
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
2411
2411
|
*
|
|
2412
2412
|
* When this parameter is omitted, the endpoint returns all employees without
|
|
2413
|
-
* limit, unlike paginated endpoints which default to 150 records.
|
|
2414
|
-
* acceptable because employees typically have low record counts.
|
|
2413
|
+
* limit, unlike paginated endpoints which default to 150 records.
|
|
2415
2414
|
*/
|
|
2416
2415
|
limit?: number;
|
|
2417
2416
|
|
|
@@ -2434,8 +2433,14 @@ export interface EmployeeListParams {
|
|
|
2434
2433
|
nameEndsWith?: string;
|
|
2435
2434
|
|
|
2436
2435
|
/**
|
|
2437
|
-
* Query param: Filter for employees whose `name`
|
|
2438
|
-
*
|
|
2436
|
+
* Query param: Filter for employees whose `name` sorts at or after this value
|
|
2437
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
2438
|
+
* first, then digits, then letters.
|
|
2439
|
+
*
|
|
2440
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns employees sorted by
|
|
2441
|
+
* `name` in that order; without either, the order is not guaranteed. To page
|
|
2442
|
+
* through employees by name, see
|
|
2443
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
2439
2444
|
*
|
|
2440
2445
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
2441
2446
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -2464,8 +2469,13 @@ export interface EmployeeListParams {
|
|
|
2464
2469
|
nameStartsWith?: string;
|
|
2465
2470
|
|
|
2466
2471
|
/**
|
|
2467
|
-
* Query param: Filter for employees whose `name`
|
|
2468
|
-
*
|
|
2472
|
+
* Query param: Filter for employees whose `name` sorts at or before this value
|
|
2473
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
2474
|
+
* first, then digits, then letters. If you also set `nameFrom`, it must not sort
|
|
2475
|
+
* after this value, or QuickBooks returns an error.
|
|
2476
|
+
*
|
|
2477
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns employees sorted by
|
|
2478
|
+
* `name` in that order; without either, the order is not guaranteed.
|
|
2469
2479
|
*
|
|
2470
2480
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
2471
2481
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1050,13 +1050,10 @@ export interface InventoryAdjustmentListParams {
|
|
|
1050
1050
|
* Query param: The maximum number of objects to return.
|
|
1051
1051
|
*
|
|
1052
1052
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
1053
|
-
* inventory adjustments
|
|
1054
|
-
* cannot fetch subsequent results using a cursor. For pagination, use the
|
|
1055
|
-
* name-range parameters instead (e.g., `nameFrom=A&nameTo=B`).
|
|
1053
|
+
* inventory adjustments, so this parameter only limits the response size.
|
|
1056
1054
|
*
|
|
1057
1055
|
* When this parameter is omitted, the endpoint returns all inventory adjustments
|
|
1058
|
-
* without limit, unlike paginated endpoints which default to 150 records.
|
|
1059
|
-
* acceptable because inventory adjustments typically have low record counts.
|
|
1056
|
+
* without limit, unlike paginated endpoints which default to 150 records.
|
|
1060
1057
|
*/
|
|
1061
1058
|
limit?: number;
|
|
1062
1059
|
|
|
@@ -1170,8 +1170,14 @@ export interface InventoryAssemblyItemListParams extends CursorPageParams {
|
|
|
1170
1170
|
nameEndsWith?: string;
|
|
1171
1171
|
|
|
1172
1172
|
/**
|
|
1173
|
-
* Query param: Filter for inventory assembly items whose `
|
|
1174
|
-
*
|
|
1173
|
+
* Query param: Filter for inventory assembly items whose `fullName` sorts at or
|
|
1174
|
+
* after this value (inclusive), compared case-insensitively in QuickBooks' sort
|
|
1175
|
+
* order: punctuation first, then digits, then letters.
|
|
1176
|
+
*
|
|
1177
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns inventory assembly items
|
|
1178
|
+
* sorted by `fullName` in that order; without either, the order is not guaranteed.
|
|
1179
|
+
* To page through inventory assembly items by name, see
|
|
1180
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
1175
1181
|
*
|
|
1176
1182
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1177
1183
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1188,8 +1194,13 @@ export interface InventoryAssemblyItemListParams extends CursorPageParams {
|
|
|
1188
1194
|
nameStartsWith?: string;
|
|
1189
1195
|
|
|
1190
1196
|
/**
|
|
1191
|
-
* Query param: Filter for inventory assembly items whose `
|
|
1192
|
-
*
|
|
1197
|
+
* Query param: Filter for inventory assembly items whose `fullName` sorts at or
|
|
1198
|
+
* before this value (inclusive), compared case-insensitively in QuickBooks' sort
|
|
1199
|
+
* order: punctuation first, then digits, then letters. If you also set `nameFrom`,
|
|
1200
|
+
* it must not sort after this value, or QuickBooks returns an error.
|
|
1201
|
+
*
|
|
1202
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns inventory assembly items
|
|
1203
|
+
* sorted by `fullName` in that order; without either, the order is not guaranteed.
|
|
1193
1204
|
*
|
|
1194
1205
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1195
1206
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1062,8 +1062,14 @@ export interface InventoryItemListParams extends CursorPageParams {
|
|
|
1062
1062
|
nameEndsWith?: string;
|
|
1063
1063
|
|
|
1064
1064
|
/**
|
|
1065
|
-
* Query param: Filter for inventory items whose `
|
|
1066
|
-
*
|
|
1065
|
+
* Query param: Filter for inventory items whose `fullName` sorts at or after this
|
|
1066
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
1067
|
+
* punctuation first, then digits, then letters.
|
|
1068
|
+
*
|
|
1069
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns inventory items sorted
|
|
1070
|
+
* by `fullName` in that order; without either, the order is not guaranteed. To
|
|
1071
|
+
* page through inventory items by name, see
|
|
1072
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
1067
1073
|
*
|
|
1068
1074
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1069
1075
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1080,8 +1086,13 @@ export interface InventoryItemListParams extends CursorPageParams {
|
|
|
1080
1086
|
nameStartsWith?: string;
|
|
1081
1087
|
|
|
1082
1088
|
/**
|
|
1083
|
-
* Query param: Filter for inventory items whose `
|
|
1084
|
-
*
|
|
1089
|
+
* Query param: Filter for inventory items whose `fullName` sorts at or before this
|
|
1090
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
1091
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
1092
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
1093
|
+
*
|
|
1094
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns inventory items sorted
|
|
1095
|
+
* by `fullName` in that order; without either, the order is not guaranteed.
|
|
1085
1096
|
*
|
|
1086
1097
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1087
1098
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -600,8 +600,9 @@ export interface InventorySiteListParams {
|
|
|
600
600
|
nameEndsWith?: string;
|
|
601
601
|
|
|
602
602
|
/**
|
|
603
|
-
* Query param: Filter for inventory sites whose `name`
|
|
604
|
-
*
|
|
603
|
+
* Query param: Filter for inventory sites whose `name` sorts at or after this
|
|
604
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
605
|
+
* punctuation first, then digits, then letters.
|
|
605
606
|
*
|
|
606
607
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
607
608
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -631,8 +632,10 @@ export interface InventorySiteListParams {
|
|
|
631
632
|
nameStartsWith?: string;
|
|
632
633
|
|
|
633
634
|
/**
|
|
634
|
-
* Query param: Filter for inventory sites whose `name`
|
|
635
|
-
*
|
|
635
|
+
* Query param: Filter for inventory sites whose `name` sorts at or before this
|
|
636
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
637
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
638
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
636
639
|
*
|
|
637
640
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
638
641
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -619,8 +619,14 @@ export interface ItemGroupListParams extends CursorPageParams {
|
|
|
619
619
|
nameEndsWith?: string;
|
|
620
620
|
|
|
621
621
|
/**
|
|
622
|
-
* Query param: Filter for item groups whose `name`
|
|
623
|
-
*
|
|
622
|
+
* Query param: Filter for item groups whose `name` sorts at or after this value
|
|
623
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
624
|
+
* first, then digits, then letters.
|
|
625
|
+
*
|
|
626
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns item groups sorted by
|
|
627
|
+
* `name` in that order; without either, the order is not guaranteed. To page
|
|
628
|
+
* through item groups by name, see
|
|
629
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
624
630
|
*
|
|
625
631
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
626
632
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -649,8 +655,13 @@ export interface ItemGroupListParams extends CursorPageParams {
|
|
|
649
655
|
nameStartsWith?: string;
|
|
650
656
|
|
|
651
657
|
/**
|
|
652
|
-
* Query param: Filter for item groups whose `name`
|
|
653
|
-
*
|
|
658
|
+
* Query param: Filter for item groups whose `name` sorts at or before this value
|
|
659
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
660
|
+
* first, then digits, then letters. If you also set `nameFrom`, it must not sort
|
|
661
|
+
* after this value, or QuickBooks returns an error.
|
|
662
|
+
*
|
|
663
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns item groups sorted by
|
|
664
|
+
* `name` in that order; without either, the order is not guaranteed.
|
|
654
665
|
*
|
|
655
666
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
656
667
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1194,8 +1194,14 @@ export interface NonInventoryItemListParams extends CursorPageParams {
|
|
|
1194
1194
|
nameEndsWith?: string;
|
|
1195
1195
|
|
|
1196
1196
|
/**
|
|
1197
|
-
* Query param: Filter for non-inventory items whose `
|
|
1198
|
-
*
|
|
1197
|
+
* Query param: Filter for non-inventory items whose `fullName` sorts at or after
|
|
1198
|
+
* this value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
1199
|
+
* punctuation first, then digits, then letters.
|
|
1200
|
+
*
|
|
1201
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns non-inventory items
|
|
1202
|
+
* sorted by `fullName` in that order; without either, the order is not guaranteed.
|
|
1203
|
+
* To page through non-inventory items by name, see
|
|
1204
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
1199
1205
|
*
|
|
1200
1206
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1201
1207
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1212,8 +1218,13 @@ export interface NonInventoryItemListParams extends CursorPageParams {
|
|
|
1212
1218
|
nameStartsWith?: string;
|
|
1213
1219
|
|
|
1214
1220
|
/**
|
|
1215
|
-
* Query param: Filter for non-inventory items whose `
|
|
1216
|
-
*
|
|
1221
|
+
* Query param: Filter for non-inventory items whose `fullName` sorts at or before
|
|
1222
|
+
* this value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
1223
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
1224
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
1225
|
+
*
|
|
1226
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns non-inventory items
|
|
1227
|
+
* sorted by `fullName` in that order; without either, the order is not guaranteed.
|
|
1217
1228
|
*
|
|
1218
1229
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1219
1230
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1098,8 +1098,14 @@ export interface OtherChargeItemListParams extends CursorPageParams {
|
|
|
1098
1098
|
nameEndsWith?: string;
|
|
1099
1099
|
|
|
1100
1100
|
/**
|
|
1101
|
-
* Query param: Filter for other charge items whose `
|
|
1102
|
-
*
|
|
1101
|
+
* Query param: Filter for other charge items whose `fullName` sorts at or after
|
|
1102
|
+
* this value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
1103
|
+
* punctuation first, then digits, then letters.
|
|
1104
|
+
*
|
|
1105
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns other charge items
|
|
1106
|
+
* sorted by `fullName` in that order; without either, the order is not guaranteed.
|
|
1107
|
+
* To page through other charge items by name, see
|
|
1108
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
1103
1109
|
*
|
|
1104
1110
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1105
1111
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -1116,8 +1122,13 @@ export interface OtherChargeItemListParams extends CursorPageParams {
|
|
|
1116
1122
|
nameStartsWith?: string;
|
|
1117
1123
|
|
|
1118
1124
|
/**
|
|
1119
|
-
* Query param: Filter for other charge items whose `
|
|
1120
|
-
*
|
|
1125
|
+
* Query param: Filter for other charge items whose `fullName` sorts at or before
|
|
1126
|
+
* this value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
1127
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
1128
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
1129
|
+
*
|
|
1130
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns other charge items
|
|
1131
|
+
* sorted by `fullName` in that order; without either, the order is not guaranteed.
|
|
1121
1132
|
*
|
|
1122
1133
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
1123
1134
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -812,13 +812,12 @@ export interface OtherNameListParams {
|
|
|
812
812
|
* Query param: The maximum number of objects to return.
|
|
813
813
|
*
|
|
814
814
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
815
|
-
* other-names
|
|
816
|
-
*
|
|
817
|
-
*
|
|
815
|
+
* other-names, so this parameter only limits the response size. To page through
|
|
816
|
+
* other-names by name, see
|
|
817
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
818
818
|
*
|
|
819
819
|
* When this parameter is omitted, the endpoint returns all other-names without
|
|
820
|
-
* limit, unlike paginated endpoints which default to 150 records.
|
|
821
|
-
* acceptable because other-names typically have low record counts.
|
|
820
|
+
* limit, unlike paginated endpoints which default to 150 records.
|
|
822
821
|
*/
|
|
823
822
|
limit?: number;
|
|
824
823
|
|
|
@@ -841,8 +840,14 @@ export interface OtherNameListParams {
|
|
|
841
840
|
nameEndsWith?: string;
|
|
842
841
|
|
|
843
842
|
/**
|
|
844
|
-
* Query param: Filter for other-names whose `name`
|
|
845
|
-
*
|
|
843
|
+
* Query param: Filter for other-names whose `name` sorts at or after this value
|
|
844
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
845
|
+
* first, then digits, then letters.
|
|
846
|
+
*
|
|
847
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns other-names sorted by
|
|
848
|
+
* `name` in that order; without either, the order is not guaranteed. To page
|
|
849
|
+
* through other-names by name, see
|
|
850
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
846
851
|
*
|
|
847
852
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
848
853
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -871,8 +876,13 @@ export interface OtherNameListParams {
|
|
|
871
876
|
nameStartsWith?: string;
|
|
872
877
|
|
|
873
878
|
/**
|
|
874
|
-
* Query param: Filter for other-names whose `name`
|
|
875
|
-
*
|
|
879
|
+
* Query param: Filter for other-names whose `name` sorts at or before this value
|
|
880
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
881
|
+
* first, then digits, then letters. If you also set `nameFrom`, it must not sort
|
|
882
|
+
* after this value, or QuickBooks returns an error.
|
|
883
|
+
*
|
|
884
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns other-names sorted by
|
|
885
|
+
* `name` in that order; without either, the order is not guaranteed.
|
|
876
886
|
*
|
|
877
887
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
878
888
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -236,13 +236,12 @@ export interface PaymentMethodListParams {
|
|
|
236
236
|
* Query param: The maximum number of objects to return.
|
|
237
237
|
*
|
|
238
238
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
239
|
-
* payment methods
|
|
240
|
-
*
|
|
241
|
-
*
|
|
239
|
+
* payment methods, so this parameter only limits the response size. To page
|
|
240
|
+
* through payment methods by name, see
|
|
241
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
242
242
|
*
|
|
243
243
|
* When this parameter is omitted, the endpoint returns all payment methods without
|
|
244
|
-
* limit, unlike paginated endpoints which default to 150 records.
|
|
245
|
-
* acceptable because payment methods typically have low record counts.
|
|
244
|
+
* limit, unlike paginated endpoints which default to 150 records.
|
|
246
245
|
*/
|
|
247
246
|
limit?: number;
|
|
248
247
|
|
|
@@ -265,8 +264,14 @@ export interface PaymentMethodListParams {
|
|
|
265
264
|
nameEndsWith?: string;
|
|
266
265
|
|
|
267
266
|
/**
|
|
268
|
-
* Query param: Filter for payment methods whose `name`
|
|
269
|
-
*
|
|
267
|
+
* Query param: Filter for payment methods whose `name` sorts at or after this
|
|
268
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
269
|
+
* punctuation first, then digits, then letters.
|
|
270
|
+
*
|
|
271
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns payment methods sorted
|
|
272
|
+
* by `name` in that order; without either, the order is not guaranteed. To page
|
|
273
|
+
* through payment methods by name, see
|
|
274
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
270
275
|
*
|
|
271
276
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
272
277
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -295,8 +300,13 @@ export interface PaymentMethodListParams {
|
|
|
295
300
|
nameStartsWith?: string;
|
|
296
301
|
|
|
297
302
|
/**
|
|
298
|
-
* Query param: Filter for payment methods whose `name`
|
|
299
|
-
*
|
|
303
|
+
* Query param: Filter for payment methods whose `name` sorts at or before this
|
|
304
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
305
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
306
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
307
|
+
*
|
|
308
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns payment methods sorted
|
|
309
|
+
* by `name` in that order; without either, the order is not guaranteed.
|
|
300
310
|
*
|
|
301
311
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
302
312
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -318,8 +318,14 @@ export interface PayrollWageItemListParams extends CursorPageParams {
|
|
|
318
318
|
nameEndsWith?: string;
|
|
319
319
|
|
|
320
320
|
/**
|
|
321
|
-
* Query param: Filter for payroll wage items whose `name`
|
|
322
|
-
*
|
|
321
|
+
* Query param: Filter for payroll wage items whose `name` sorts at or after this
|
|
322
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
323
|
+
* punctuation first, then digits, then letters.
|
|
324
|
+
*
|
|
325
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns payroll wage items
|
|
326
|
+
* sorted by `name` in that order; without either, the order is not guaranteed. To
|
|
327
|
+
* page through payroll wage items by name, see
|
|
328
|
+
* [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
|
|
323
329
|
*
|
|
324
330
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
325
331
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -349,8 +355,13 @@ export interface PayrollWageItemListParams extends CursorPageParams {
|
|
|
349
355
|
nameStartsWith?: string;
|
|
350
356
|
|
|
351
357
|
/**
|
|
352
|
-
* Query param: Filter for payroll wage items whose `name`
|
|
353
|
-
*
|
|
358
|
+
* Query param: Filter for payroll wage items whose `name` sorts at or before this
|
|
359
|
+
* value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
360
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
361
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
362
|
+
*
|
|
363
|
+
* When you set `nameFrom` or `nameTo`, QuickBooks returns payroll wage items
|
|
364
|
+
* sorted by `name` in that order; without either, the order is not guaranteed.
|
|
354
365
|
*
|
|
355
366
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
356
367
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -502,21 +502,19 @@ export interface PriceLevelListParams {
|
|
|
502
502
|
ids?: Array<string>;
|
|
503
503
|
|
|
504
504
|
/**
|
|
505
|
-
* Query param: Filter for price levels containing
|
|
505
|
+
* Query param: Filter for price levels containing this item. QuickBooks Desktop
|
|
506
|
+
* accepts only one item for this filter.
|
|
506
507
|
*/
|
|
507
|
-
|
|
508
|
+
itemId?: string;
|
|
508
509
|
|
|
509
510
|
/**
|
|
510
511
|
* Query param: The maximum number of objects to return.
|
|
511
512
|
*
|
|
512
513
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
513
|
-
* price levels
|
|
514
|
-
* subsequent results using a cursor. For pagination, use the name-range parameters
|
|
515
|
-
* instead (e.g., `nameFrom=A&nameTo=B`).
|
|
514
|
+
* price levels, so this parameter only limits the response size.
|
|
516
515
|
*
|
|
517
516
|
* When this parameter is omitted, the endpoint returns all price levels without
|
|
518
|
-
* limit, unlike paginated endpoints which default to 150 records.
|
|
519
|
-
* acceptable because price levels typically have low record counts.
|
|
517
|
+
* limit, unlike paginated endpoints which default to 150 records.
|
|
520
518
|
*/
|
|
521
519
|
limit?: number;
|
|
522
520
|
|
|
@@ -539,8 +537,14 @@ export interface PriceLevelListParams {
|
|
|
539
537
|
nameEndsWith?: string;
|
|
540
538
|
|
|
541
539
|
/**
|
|
542
|
-
* Query param: Filter for price levels whose `name`
|
|
543
|
-
*
|
|
540
|
+
* Query param: Filter for price levels whose `name` sorts at or after this value
|
|
541
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
542
|
+
* first, then digits, then letters.
|
|
543
|
+
*
|
|
544
|
+
* **IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks does not
|
|
545
|
+
* return price levels sorted by name: it returns fixed-percentage price levels
|
|
546
|
+
* first, then per-item price levels, each group sorted by name. Do not use these
|
|
547
|
+
* parameters to page through price levels.
|
|
544
548
|
*
|
|
545
549
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
546
550
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -569,8 +573,15 @@ export interface PriceLevelListParams {
|
|
|
569
573
|
nameStartsWith?: string;
|
|
570
574
|
|
|
571
575
|
/**
|
|
572
|
-
* Query param: Filter for price levels whose `name`
|
|
573
|
-
*
|
|
576
|
+
* Query param: Filter for price levels whose `name` sorts at or before this value
|
|
577
|
+
* (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
|
|
578
|
+
* first, then digits, then letters. If you also set `nameFrom`, it must not sort
|
|
579
|
+
* after this value, or QuickBooks returns an error.
|
|
580
|
+
*
|
|
581
|
+
* **IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks does not
|
|
582
|
+
* return price levels sorted by name: it returns fixed-percentage price levels
|
|
583
|
+
* first, then per-item price levels, each group sorted by name. Do not use these
|
|
584
|
+
* parameters to page through price levels.
|
|
574
585
|
*
|
|
575
586
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
576
587
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -298,13 +298,10 @@ export interface SalesRepresentativeListParams {
|
|
|
298
298
|
* Query param: The maximum number of objects to return.
|
|
299
299
|
*
|
|
300
300
|
* **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
|
|
301
|
-
* sales representatives
|
|
302
|
-
* cannot fetch subsequent results using a cursor. For pagination, use the
|
|
303
|
-
* name-range parameters instead (e.g., `nameFrom=A&nameTo=B`).
|
|
301
|
+
* sales representatives, so this parameter only limits the response size.
|
|
304
302
|
*
|
|
305
303
|
* When this parameter is omitted, the endpoint returns all sales representatives
|
|
306
|
-
* without limit, unlike paginated endpoints which default to 150 records.
|
|
307
|
-
* acceptable because sales representatives typically have low record counts.
|
|
304
|
+
* without limit, unlike paginated endpoints which default to 150 records.
|
|
308
305
|
*/
|
|
309
306
|
limit?: number;
|
|
310
307
|
|
|
@@ -327,8 +324,9 @@ export interface SalesRepresentativeListParams {
|
|
|
327
324
|
nameEndsWith?: string;
|
|
328
325
|
|
|
329
326
|
/**
|
|
330
|
-
* Query param: Filter for sales representatives whose `
|
|
331
|
-
*
|
|
327
|
+
* Query param: Filter for sales representatives whose `initial` sorts at or after
|
|
328
|
+
* this value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
329
|
+
* punctuation first, then digits, then letters.
|
|
332
330
|
*
|
|
333
331
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
334
332
|
* `nameStartsWith`, or `nameEndsWith`.
|
|
@@ -358,8 +356,10 @@ export interface SalesRepresentativeListParams {
|
|
|
358
356
|
nameStartsWith?: string;
|
|
359
357
|
|
|
360
358
|
/**
|
|
361
|
-
* Query param: Filter for sales representatives whose `
|
|
362
|
-
*
|
|
359
|
+
* Query param: Filter for sales representatives whose `initial` sorts at or before
|
|
360
|
+
* this value (inclusive), compared case-insensitively in QuickBooks' sort order:
|
|
361
|
+
* punctuation first, then digits, then letters. If you also set `nameFrom`, it
|
|
362
|
+
* must not sort after this value, or QuickBooks returns an error.
|
|
363
363
|
*
|
|
364
364
|
* **NOTE**: If you use this parameter, you cannot also use `nameContains`,
|
|
365
365
|
* `nameStartsWith`, or `nameEndsWith`.
|