conductor-node 12.0.1 → 12.1.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 +27 -0
- package/core.d.ts +12 -1
- package/core.d.ts.map +1 -1
- package/core.js +5 -5
- package/core.js.map +1 -1
- package/core.mjs +5 -5
- package/core.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/end-users.d.ts +2 -1
- package/resources/end-users.d.ts.map +1 -1
- package/resources/end-users.js +4 -4
- package/resources/end-users.js.map +1 -1
- package/resources/end-users.mjs +4 -4
- package/resources/end-users.mjs.map +1 -1
- package/resources/qbd/bills.d.ts +45 -45
- package/resources/qbd/checks.d.ts +45 -45
- package/resources/qbd/credit-card-charges.d.ts +45 -45
- package/resources/qbd/credit-card-credits.d.ts +45 -45
- package/resources/qbd/index.d.ts +1 -0
- package/resources/qbd/index.d.ts.map +1 -1
- package/resources/qbd/index.js +5 -2
- package/resources/qbd/index.js.map +1 -1
- package/resources/qbd/index.mjs +1 -0
- package/resources/qbd/index.mjs.map +1 -1
- package/resources/qbd/item-groups.d.ts +490 -0
- package/resources/qbd/item-groups.d.ts.map +1 -0
- package/resources/qbd/item-groups.js +58 -0
- package/resources/qbd/item-groups.js.map +1 -0
- package/resources/qbd/item-groups.mjs +53 -0
- package/resources/qbd/item-groups.mjs.map +1 -0
- package/resources/qbd/item-receipts.d.ts +45 -45
- package/resources/qbd/qbd.d.ts +4 -0
- package/resources/qbd/qbd.d.ts.map +1 -1
- package/resources/qbd/qbd.js +5 -0
- package/resources/qbd/qbd.js.map +1 -1
- package/resources/qbd/qbd.mjs +5 -0
- package/resources/qbd/qbd.mjs.map +1 -1
- package/resources/qbd/vendor-credits.d.ts +45 -45
- package/src/core.ts +18 -4
- package/src/resources/end-users.ts +16 -1
- package/src/resources/qbd/bills.ts +45 -45
- package/src/resources/qbd/checks.ts +45 -45
- package/src/resources/qbd/credit-card-charges.ts +45 -45
- package/src/resources/qbd/credit-card-credits.ts +45 -45
- package/src/resources/qbd/index.ts +9 -0
- package/src/resources/qbd/item-groups.ts +621 -0
- package/src/resources/qbd/item-receipts.ts +45 -45
- package/src/resources/qbd/qbd.ts +23 -0
- package/src/resources/qbd/vendor-credits.ts +45 -45
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -82,7 +82,7 @@ export interface VendorCredit {
|
|
|
82
82
|
* items bundled together because they are commonly purchased together or grouped
|
|
83
83
|
* for faster entry.
|
|
84
84
|
*/
|
|
85
|
-
|
|
85
|
+
itemGroupLines: Array<VendorCredit.ItemGroupLine>;
|
|
86
86
|
/**
|
|
87
87
|
* The vendor credit's item lines, each representing the purchase of a specific
|
|
88
88
|
* item or service.
|
|
@@ -399,47 +399,47 @@ export declare namespace VendorCredit {
|
|
|
399
399
|
fullName: string | null;
|
|
400
400
|
}
|
|
401
401
|
}
|
|
402
|
-
interface
|
|
402
|
+
interface ItemGroupLine {
|
|
403
403
|
/**
|
|
404
|
-
* The unique identifier assigned by QuickBooks to this item line
|
|
404
|
+
* The unique identifier assigned by QuickBooks to this item group line. This ID is
|
|
405
405
|
* unique across all transaction line types.
|
|
406
406
|
*/
|
|
407
407
|
id: string;
|
|
408
408
|
/**
|
|
409
|
-
* The custom fields for the item line
|
|
409
|
+
* The custom fields for the item group line object, added as user-defined data
|
|
410
410
|
* extensions, not included in the standard QuickBooks object.
|
|
411
411
|
*/
|
|
412
|
-
customFields: Array<
|
|
412
|
+
customFields: Array<ItemGroupLine.CustomField>;
|
|
413
413
|
/**
|
|
414
|
-
* A description of this item line
|
|
414
|
+
* A description of this item group line.
|
|
415
415
|
*/
|
|
416
416
|
description: string | null;
|
|
417
417
|
/**
|
|
418
|
-
* The item line
|
|
418
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
419
419
|
* because they are commonly purchased together or grouped for faster entry.
|
|
420
420
|
*/
|
|
421
|
-
itemGroup:
|
|
421
|
+
itemGroup: ItemGroupLine.ItemGroup;
|
|
422
422
|
/**
|
|
423
|
-
* The item line
|
|
423
|
+
* The item group line's item lines, each representing the purchase of a specific
|
|
424
424
|
* item or service.
|
|
425
425
|
*/
|
|
426
|
-
itemLines: Array<
|
|
426
|
+
itemLines: Array<ItemGroupLine.ItemLine>;
|
|
427
427
|
/**
|
|
428
|
-
* The type of object. This value is always `"
|
|
428
|
+
* The type of object. This value is always `"qbd_item_group_line"`.
|
|
429
429
|
*/
|
|
430
|
-
objectType: '
|
|
430
|
+
objectType: 'qbd_item_group_line';
|
|
431
431
|
/**
|
|
432
|
-
* Specifies an alternative unit-of-measure set when updating this item
|
|
433
|
-
*
|
|
432
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
433
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
434
434
|
* select units from a different set than the item's default unit-of-measure set,
|
|
435
435
|
* which remains unchanged on the item itself. The override applies only to this
|
|
436
436
|
* specific line. For example, you can sell an item typically measured in volume
|
|
437
437
|
* units using weight units in a specific transaction by specifying a different
|
|
438
438
|
* unit-of-measure set with this field.
|
|
439
439
|
*/
|
|
440
|
-
overrideUnitOfMeasureSet:
|
|
440
|
+
overrideUnitOfMeasureSet: ItemGroupLine.OverrideUnitOfMeasureSet | null;
|
|
441
441
|
/**
|
|
442
|
-
* The quantity of the item group associated with this item line
|
|
442
|
+
* The quantity of the item group associated with this item group line. This field
|
|
443
443
|
* cannot be cleared.
|
|
444
444
|
*
|
|
445
445
|
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
@@ -447,17 +447,17 @@ export declare namespace VendorCredit {
|
|
|
447
447
|
*/
|
|
448
448
|
quantity: number | null;
|
|
449
449
|
/**
|
|
450
|
-
* The total monetary amount of this item line
|
|
450
|
+
* The total monetary amount of this item group line, equivalent to the sum of the
|
|
451
451
|
* amounts in `lines`, represented as a decimal string.
|
|
452
452
|
*/
|
|
453
453
|
totalAmount: string;
|
|
454
454
|
/**
|
|
455
|
-
* The unit-of-measure used for the `quantity` in this item line
|
|
455
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
456
456
|
* valid unit within the item's available units of measure.
|
|
457
457
|
*/
|
|
458
458
|
unitOfMeasure: string | null;
|
|
459
459
|
}
|
|
460
|
-
namespace
|
|
460
|
+
namespace ItemGroupLine {
|
|
461
461
|
interface CustomField {
|
|
462
462
|
/**
|
|
463
463
|
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
@@ -485,7 +485,7 @@ export declare namespace VendorCredit {
|
|
|
485
485
|
value: string;
|
|
486
486
|
}
|
|
487
487
|
/**
|
|
488
|
-
* The item line
|
|
488
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
489
489
|
* because they are commonly purchased together or grouped for faster entry.
|
|
490
490
|
*/
|
|
491
491
|
interface ItemGroup {
|
|
@@ -812,8 +812,8 @@ export declare namespace VendorCredit {
|
|
|
812
812
|
}
|
|
813
813
|
}
|
|
814
814
|
/**
|
|
815
|
-
* Specifies an alternative unit-of-measure set when updating this item
|
|
816
|
-
*
|
|
815
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
816
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
817
817
|
* select units from a different set than the item's default unit-of-measure set,
|
|
818
818
|
* which remains unchanged on the item itself. The override applies only to this
|
|
819
819
|
* specific line. For example, you can sell an item typically measured in volume
|
|
@@ -1303,7 +1303,7 @@ export interface VendorCreditCreateParams {
|
|
|
1303
1303
|
* set of items bundled together because they are commonly purchased together or
|
|
1304
1304
|
* grouped for faster entry.
|
|
1305
1305
|
*/
|
|
1306
|
-
|
|
1306
|
+
itemGroupLines?: Array<VendorCreditCreateParams.ItemGroupLine>;
|
|
1307
1307
|
/**
|
|
1308
1308
|
* Body param: The vendor credit's item lines, each representing the purchase of a
|
|
1309
1309
|
* specific item or service.
|
|
@@ -1423,29 +1423,29 @@ export declare namespace VendorCreditCreateParams {
|
|
|
1423
1423
|
value: string;
|
|
1424
1424
|
}
|
|
1425
1425
|
}
|
|
1426
|
-
interface
|
|
1426
|
+
interface ItemGroupLine {
|
|
1427
1427
|
/**
|
|
1428
|
-
* The item line
|
|
1428
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
1429
1429
|
* because they are commonly purchased together or grouped for faster entry.
|
|
1430
1430
|
*/
|
|
1431
1431
|
itemGroupId: string;
|
|
1432
1432
|
/**
|
|
1433
|
-
* The custom fields for the item line
|
|
1433
|
+
* The custom fields for the item group line object, added as user-defined data
|
|
1434
1434
|
* extensions, not included in the standard QuickBooks object.
|
|
1435
1435
|
*/
|
|
1436
|
-
customFields?: Array<
|
|
1436
|
+
customFields?: Array<ItemGroupLine.CustomField>;
|
|
1437
1437
|
/**
|
|
1438
1438
|
* The site location where inventory for the item group associated with this item
|
|
1439
|
-
* line
|
|
1439
|
+
* group line is stored.
|
|
1440
1440
|
*/
|
|
1441
1441
|
inventorySiteId?: string;
|
|
1442
1442
|
/**
|
|
1443
1443
|
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1444
|
-
* item group associated with this item line
|
|
1444
|
+
* item group associated with this item group line is stored.
|
|
1445
1445
|
*/
|
|
1446
1446
|
inventorySiteLocationId?: string;
|
|
1447
1447
|
/**
|
|
1448
|
-
* The quantity of the item group associated with this item line
|
|
1448
|
+
* The quantity of the item group associated with this item group line. This field
|
|
1449
1449
|
* cannot be cleared.
|
|
1450
1450
|
*
|
|
1451
1451
|
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
@@ -1453,12 +1453,12 @@ export declare namespace VendorCreditCreateParams {
|
|
|
1453
1453
|
*/
|
|
1454
1454
|
quantity?: number;
|
|
1455
1455
|
/**
|
|
1456
|
-
* The unit-of-measure used for the `quantity` in this item line
|
|
1456
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
1457
1457
|
* valid unit within the item's available units of measure.
|
|
1458
1458
|
*/
|
|
1459
1459
|
unitOfMeasure?: string;
|
|
1460
1460
|
}
|
|
1461
|
-
namespace
|
|
1461
|
+
namespace ItemGroupLine {
|
|
1462
1462
|
interface CustomField {
|
|
1463
1463
|
/**
|
|
1464
1464
|
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
@@ -1764,7 +1764,7 @@ export interface VendorCreditUpdateParams {
|
|
|
1764
1764
|
* 3. If you do not wish to modify any item group lines, omit this field entirely
|
|
1765
1765
|
* to keep them unchanged.
|
|
1766
1766
|
*/
|
|
1767
|
-
|
|
1767
|
+
itemGroupLines?: Array<VendorCreditUpdateParams.ItemGroupLine>;
|
|
1768
1768
|
/**
|
|
1769
1769
|
* Body param: The vendor credit's item lines, each representing the purchase of a
|
|
1770
1770
|
* specific item or service.
|
|
@@ -1882,27 +1882,27 @@ export declare namespace VendorCreditUpdateParams {
|
|
|
1882
1882
|
*/
|
|
1883
1883
|
salesTaxCodeId?: string;
|
|
1884
1884
|
}
|
|
1885
|
-
interface
|
|
1885
|
+
interface ItemGroupLine {
|
|
1886
1886
|
/**
|
|
1887
|
-
* The QuickBooks-assigned unique identifier of an existing item line
|
|
1887
|
+
* The QuickBooks-assigned unique identifier of an existing item group line you
|
|
1888
1888
|
* wish to retain or update.
|
|
1889
1889
|
*
|
|
1890
|
-
* **IMPORTANT**: Set this field to `-1` for new item
|
|
1890
|
+
* **IMPORTANT**: Set this field to `-1` for new item group lines you wish to add.
|
|
1891
1891
|
*/
|
|
1892
1892
|
id: string;
|
|
1893
1893
|
/**
|
|
1894
|
-
* The item line
|
|
1894
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
1895
1895
|
* because they are commonly purchased together or grouped for faster entry.
|
|
1896
1896
|
*/
|
|
1897
1897
|
itemGroupId?: string;
|
|
1898
1898
|
/**
|
|
1899
|
-
* The item line
|
|
1899
|
+
* The item group line's item lines, each representing the purchase of a specific
|
|
1900
1900
|
* item or service.
|
|
1901
1901
|
*
|
|
1902
1902
|
* **IMPORTANT**:
|
|
1903
1903
|
*
|
|
1904
1904
|
* 1. Including this array in your update request will **REPLACE** all existing
|
|
1905
|
-
* item lines for the item line
|
|
1905
|
+
* item lines for the item group line with this array. To keep any existing item
|
|
1906
1906
|
* lines, you must include them in this array even if they have not changed.
|
|
1907
1907
|
* **Any item lines not included will be removed.**
|
|
1908
1908
|
*
|
|
@@ -1911,10 +1911,10 @@ export declare namespace VendorCreditUpdateParams {
|
|
|
1911
1911
|
* 3. If you do not wish to modify any item lines, omit this field entirely to keep
|
|
1912
1912
|
* them unchanged.
|
|
1913
1913
|
*/
|
|
1914
|
-
itemLines?: Array<
|
|
1914
|
+
itemLines?: Array<ItemGroupLine.ItemLine>;
|
|
1915
1915
|
/**
|
|
1916
|
-
* Specifies an alternative unit-of-measure set when updating this item
|
|
1917
|
-
*
|
|
1916
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
1917
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
1918
1918
|
* select units from a different set than the item's default unit-of-measure set,
|
|
1919
1919
|
* which remains unchanged on the item itself. The override applies only to this
|
|
1920
1920
|
* specific line. For example, you can sell an item typically measured in volume
|
|
@@ -1923,7 +1923,7 @@ export declare namespace VendorCreditUpdateParams {
|
|
|
1923
1923
|
*/
|
|
1924
1924
|
overrideUnitOfMeasureSetId?: string;
|
|
1925
1925
|
/**
|
|
1926
|
-
* The quantity of the item group associated with this item line
|
|
1926
|
+
* The quantity of the item group associated with this item group line. This field
|
|
1927
1927
|
* cannot be cleared.
|
|
1928
1928
|
*
|
|
1929
1929
|
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
@@ -1931,12 +1931,12 @@ export declare namespace VendorCreditUpdateParams {
|
|
|
1931
1931
|
*/
|
|
1932
1932
|
quantity?: number;
|
|
1933
1933
|
/**
|
|
1934
|
-
* The unit-of-measure used for the `quantity` in this item line
|
|
1934
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
1935
1935
|
* valid unit within the item's available units of measure.
|
|
1936
1936
|
*/
|
|
1937
1937
|
unitOfMeasure?: string;
|
|
1938
1938
|
}
|
|
1939
|
-
namespace
|
|
1939
|
+
namespace ItemGroupLine {
|
|
1940
1940
|
interface ItemLine {
|
|
1941
1941
|
/**
|
|
1942
1942
|
* The QuickBooks-assigned unique identifier of an existing item line you wish to
|
package/src/core.ts
CHANGED
|
@@ -33,6 +33,20 @@ export {
|
|
|
33
33
|
|
|
34
34
|
export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
|
|
35
35
|
|
|
36
|
+
/**
|
|
37
|
+
* An alias to the builtin `Array` type so we can
|
|
38
|
+
* easily alias it in import statements if there are name clashes.
|
|
39
|
+
*/
|
|
40
|
+
type _Array<T> = Array<T>;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* An alias to the builtin `Record` type so we can
|
|
44
|
+
* easily alias it in import statements if there are name clashes.
|
|
45
|
+
*/
|
|
46
|
+
type _Record<K extends keyof any, T> = Record<K, T>;
|
|
47
|
+
|
|
48
|
+
export type { _Array as Array, _Record as Record };
|
|
49
|
+
|
|
36
50
|
type PromiseOrValue<T> = T | Promise<T>;
|
|
37
51
|
|
|
38
52
|
type APIResponseProps = {
|
|
@@ -282,10 +296,10 @@ export abstract class APIClient {
|
|
|
282
296
|
}
|
|
283
297
|
|
|
284
298
|
buildRequest<Req>(
|
|
285
|
-
|
|
299
|
+
inputOptions: FinalRequestOptions<Req>,
|
|
286
300
|
{ retryCount = 0 }: { retryCount?: number } = {},
|
|
287
301
|
): { req: RequestInit; url: string; timeout: number } {
|
|
288
|
-
options = { ...
|
|
302
|
+
const options = { ...inputOptions };
|
|
289
303
|
const { method, path, query, headers: headers = {} } = options;
|
|
290
304
|
|
|
291
305
|
const body =
|
|
@@ -313,8 +327,8 @@ export abstract class APIClient {
|
|
|
313
327
|
}
|
|
314
328
|
|
|
315
329
|
if (this.idempotencyHeader && method !== 'get') {
|
|
316
|
-
if (!
|
|
317
|
-
headers[this.idempotencyHeader] =
|
|
330
|
+
if (!inputOptions.idempotencyKey) inputOptions.idempotencyKey = this.defaultIdempotencyKey();
|
|
331
|
+
headers[this.idempotencyHeader] = inputOptions.idempotencyKey;
|
|
318
332
|
}
|
|
319
333
|
|
|
320
334
|
const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../resource';
|
|
4
|
+
import { isRequestOptions } from '../core';
|
|
4
5
|
import * as Core from '../core';
|
|
5
6
|
|
|
6
7
|
export class EndUsers extends APIResource {
|
|
@@ -39,9 +40,23 @@ export class EndUsers extends APIResource {
|
|
|
39
40
|
passthrough(
|
|
40
41
|
id: string,
|
|
41
42
|
integrationSlug: 'quickbooks_desktop',
|
|
42
|
-
body
|
|
43
|
+
body?: EndUserPassthroughParams,
|
|
44
|
+
options?: Core.RequestOptions,
|
|
45
|
+
): Core.APIPromise<EndUserPassthroughResponse>;
|
|
46
|
+
passthrough(
|
|
47
|
+
id: string,
|
|
48
|
+
integrationSlug: 'quickbooks_desktop',
|
|
49
|
+
options?: Core.RequestOptions,
|
|
50
|
+
): Core.APIPromise<EndUserPassthroughResponse>;
|
|
51
|
+
passthrough(
|
|
52
|
+
id: string,
|
|
53
|
+
integrationSlug: 'quickbooks_desktop',
|
|
54
|
+
body?: EndUserPassthroughParams | Core.RequestOptions,
|
|
43
55
|
options?: Core.RequestOptions,
|
|
44
56
|
): Core.APIPromise<EndUserPassthroughResponse> {
|
|
57
|
+
if (isRequestOptions(body)) {
|
|
58
|
+
return this.passthrough(id, integrationSlug, undefined, body);
|
|
59
|
+
}
|
|
45
60
|
return this._client.post(`/end-users/${id}/passthrough/${integrationSlug}`, { body, ...options });
|
|
46
61
|
}
|
|
47
62
|
}
|
|
@@ -151,7 +151,7 @@ export interface Bill {
|
|
|
151
151
|
* together because they are commonly purchased together or grouped for faster
|
|
152
152
|
* entry.
|
|
153
153
|
*/
|
|
154
|
-
|
|
154
|
+
itemGroupLines: Array<Bill.ItemGroupLine>;
|
|
155
155
|
|
|
156
156
|
/**
|
|
157
157
|
* The bill's item lines, each representing the purchase of a specific item or
|
|
@@ -539,54 +539,54 @@ export namespace Bill {
|
|
|
539
539
|
}
|
|
540
540
|
}
|
|
541
541
|
|
|
542
|
-
export interface
|
|
542
|
+
export interface ItemGroupLine {
|
|
543
543
|
/**
|
|
544
|
-
* The unique identifier assigned by QuickBooks to this item line
|
|
544
|
+
* The unique identifier assigned by QuickBooks to this item group line. This ID is
|
|
545
545
|
* unique across all transaction line types.
|
|
546
546
|
*/
|
|
547
547
|
id: string;
|
|
548
548
|
|
|
549
549
|
/**
|
|
550
|
-
* The custom fields for the item line
|
|
550
|
+
* The custom fields for the item group line object, added as user-defined data
|
|
551
551
|
* extensions, not included in the standard QuickBooks object.
|
|
552
552
|
*/
|
|
553
|
-
customFields: Array<
|
|
553
|
+
customFields: Array<ItemGroupLine.CustomField>;
|
|
554
554
|
|
|
555
555
|
/**
|
|
556
|
-
* A description of this item line
|
|
556
|
+
* A description of this item group line.
|
|
557
557
|
*/
|
|
558
558
|
description: string | null;
|
|
559
559
|
|
|
560
560
|
/**
|
|
561
|
-
* The item line
|
|
561
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
562
562
|
* because they are commonly purchased together or grouped for faster entry.
|
|
563
563
|
*/
|
|
564
|
-
itemGroup:
|
|
564
|
+
itemGroup: ItemGroupLine.ItemGroup;
|
|
565
565
|
|
|
566
566
|
/**
|
|
567
|
-
* The item line
|
|
567
|
+
* The item group line's item lines, each representing the purchase of a specific
|
|
568
568
|
* item or service.
|
|
569
569
|
*/
|
|
570
|
-
itemLines: Array<
|
|
570
|
+
itemLines: Array<ItemGroupLine.ItemLine>;
|
|
571
571
|
|
|
572
572
|
/**
|
|
573
|
-
* The type of object. This value is always `"
|
|
573
|
+
* The type of object. This value is always `"qbd_item_group_line"`.
|
|
574
574
|
*/
|
|
575
|
-
objectType: '
|
|
575
|
+
objectType: 'qbd_item_group_line';
|
|
576
576
|
|
|
577
577
|
/**
|
|
578
|
-
* Specifies an alternative unit-of-measure set when updating this item
|
|
579
|
-
*
|
|
578
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
579
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
580
580
|
* select units from a different set than the item's default unit-of-measure set,
|
|
581
581
|
* which remains unchanged on the item itself. The override applies only to this
|
|
582
582
|
* specific line. For example, you can sell an item typically measured in volume
|
|
583
583
|
* units using weight units in a specific transaction by specifying a different
|
|
584
584
|
* unit-of-measure set with this field.
|
|
585
585
|
*/
|
|
586
|
-
overrideUnitOfMeasureSet:
|
|
586
|
+
overrideUnitOfMeasureSet: ItemGroupLine.OverrideUnitOfMeasureSet | null;
|
|
587
587
|
|
|
588
588
|
/**
|
|
589
|
-
* The quantity of the item group associated with this item line
|
|
589
|
+
* The quantity of the item group associated with this item group line. This field
|
|
590
590
|
* cannot be cleared.
|
|
591
591
|
*
|
|
592
592
|
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
@@ -595,19 +595,19 @@ export namespace Bill {
|
|
|
595
595
|
quantity: number | null;
|
|
596
596
|
|
|
597
597
|
/**
|
|
598
|
-
* The total monetary amount of this item line
|
|
598
|
+
* The total monetary amount of this item group line, equivalent to the sum of the
|
|
599
599
|
* amounts in `lines`, represented as a decimal string.
|
|
600
600
|
*/
|
|
601
601
|
totalAmount: string;
|
|
602
602
|
|
|
603
603
|
/**
|
|
604
|
-
* The unit-of-measure used for the `quantity` in this item line
|
|
604
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
605
605
|
* valid unit within the item's available units of measure.
|
|
606
606
|
*/
|
|
607
607
|
unitOfMeasure: string | null;
|
|
608
608
|
}
|
|
609
609
|
|
|
610
|
-
export namespace
|
|
610
|
+
export namespace ItemGroupLine {
|
|
611
611
|
export interface CustomField {
|
|
612
612
|
/**
|
|
613
613
|
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
@@ -647,7 +647,7 @@ export namespace Bill {
|
|
|
647
647
|
}
|
|
648
648
|
|
|
649
649
|
/**
|
|
650
|
-
* The item line
|
|
650
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
651
651
|
* because they are commonly purchased together or grouped for faster entry.
|
|
652
652
|
*/
|
|
653
653
|
export interface ItemGroup {
|
|
@@ -1024,8 +1024,8 @@ export namespace Bill {
|
|
|
1024
1024
|
}
|
|
1025
1025
|
|
|
1026
1026
|
/**
|
|
1027
|
-
* Specifies an alternative unit-of-measure set when updating this item
|
|
1028
|
-
*
|
|
1027
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
1028
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
1029
1029
|
* select units from a different set than the item's default unit-of-measure set,
|
|
1030
1030
|
* which remains unchanged on the item itself. The override applies only to this
|
|
1031
1031
|
* specific line. For example, you can sell an item typically measured in volume
|
|
@@ -1696,7 +1696,7 @@ export interface BillCreateParams {
|
|
|
1696
1696
|
* items bundled together because they are commonly purchased together or grouped
|
|
1697
1697
|
* for faster entry.
|
|
1698
1698
|
*/
|
|
1699
|
-
|
|
1699
|
+
itemGroupLines?: Array<BillCreateParams.ItemGroupLine>;
|
|
1700
1700
|
|
|
1701
1701
|
/**
|
|
1702
1702
|
* Body param: The bill's item lines, each representing the purchase of a specific
|
|
@@ -1870,33 +1870,33 @@ export namespace BillCreateParams {
|
|
|
1870
1870
|
}
|
|
1871
1871
|
}
|
|
1872
1872
|
|
|
1873
|
-
export interface
|
|
1873
|
+
export interface ItemGroupLine {
|
|
1874
1874
|
/**
|
|
1875
|
-
* The item line
|
|
1875
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
1876
1876
|
* because they are commonly purchased together or grouped for faster entry.
|
|
1877
1877
|
*/
|
|
1878
1878
|
itemGroupId: string;
|
|
1879
1879
|
|
|
1880
1880
|
/**
|
|
1881
|
-
* The custom fields for the item line
|
|
1881
|
+
* The custom fields for the item group line object, added as user-defined data
|
|
1882
1882
|
* extensions, not included in the standard QuickBooks object.
|
|
1883
1883
|
*/
|
|
1884
|
-
customFields?: Array<
|
|
1884
|
+
customFields?: Array<ItemGroupLine.CustomField>;
|
|
1885
1885
|
|
|
1886
1886
|
/**
|
|
1887
1887
|
* The site location where inventory for the item group associated with this item
|
|
1888
|
-
* line
|
|
1888
|
+
* group line is stored.
|
|
1889
1889
|
*/
|
|
1890
1890
|
inventorySiteId?: string;
|
|
1891
1891
|
|
|
1892
1892
|
/**
|
|
1893
1893
|
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1894
|
-
* item group associated with this item line
|
|
1894
|
+
* item group associated with this item group line is stored.
|
|
1895
1895
|
*/
|
|
1896
1896
|
inventorySiteLocationId?: string;
|
|
1897
1897
|
|
|
1898
1898
|
/**
|
|
1899
|
-
* The quantity of the item group associated with this item line
|
|
1899
|
+
* The quantity of the item group associated with this item group line. This field
|
|
1900
1900
|
* cannot be cleared.
|
|
1901
1901
|
*
|
|
1902
1902
|
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
@@ -1905,13 +1905,13 @@ export namespace BillCreateParams {
|
|
|
1905
1905
|
quantity?: number;
|
|
1906
1906
|
|
|
1907
1907
|
/**
|
|
1908
|
-
* The unit-of-measure used for the `quantity` in this item line
|
|
1908
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
1909
1909
|
* valid unit within the item's available units of measure.
|
|
1910
1910
|
*/
|
|
1911
1911
|
unitOfMeasure?: string;
|
|
1912
1912
|
}
|
|
1913
1913
|
|
|
1914
|
-
export namespace
|
|
1914
|
+
export namespace ItemGroupLine {
|
|
1915
1915
|
export interface CustomField {
|
|
1916
1916
|
/**
|
|
1917
1917
|
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
@@ -2328,7 +2328,7 @@ export interface BillUpdateParams {
|
|
|
2328
2328
|
* 3. If you do not wish to modify any item group lines, omit this field entirely
|
|
2329
2329
|
* to keep them unchanged.
|
|
2330
2330
|
*/
|
|
2331
|
-
|
|
2331
|
+
itemGroupLines?: Array<BillUpdateParams.ItemGroupLine>;
|
|
2332
2332
|
|
|
2333
2333
|
/**
|
|
2334
2334
|
* Body param: The bill's item lines, each representing the purchase of a specific
|
|
@@ -2473,29 +2473,29 @@ export namespace BillUpdateParams {
|
|
|
2473
2473
|
salesTaxCodeId?: string;
|
|
2474
2474
|
}
|
|
2475
2475
|
|
|
2476
|
-
export interface
|
|
2476
|
+
export interface ItemGroupLine {
|
|
2477
2477
|
/**
|
|
2478
|
-
* The QuickBooks-assigned unique identifier of an existing item line
|
|
2478
|
+
* The QuickBooks-assigned unique identifier of an existing item group line you
|
|
2479
2479
|
* wish to retain or update.
|
|
2480
2480
|
*
|
|
2481
|
-
* **IMPORTANT**: Set this field to `-1` for new item
|
|
2481
|
+
* **IMPORTANT**: Set this field to `-1` for new item group lines you wish to add.
|
|
2482
2482
|
*/
|
|
2483
2483
|
id: string;
|
|
2484
2484
|
|
|
2485
2485
|
/**
|
|
2486
|
-
* The item line
|
|
2486
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
2487
2487
|
* because they are commonly purchased together or grouped for faster entry.
|
|
2488
2488
|
*/
|
|
2489
2489
|
itemGroupId?: string;
|
|
2490
2490
|
|
|
2491
2491
|
/**
|
|
2492
|
-
* The item line
|
|
2492
|
+
* The item group line's item lines, each representing the purchase of a specific
|
|
2493
2493
|
* item or service.
|
|
2494
2494
|
*
|
|
2495
2495
|
* **IMPORTANT**:
|
|
2496
2496
|
*
|
|
2497
2497
|
* 1. Including this array in your update request will **REPLACE** all existing
|
|
2498
|
-
* item lines for the item line
|
|
2498
|
+
* item lines for the item group line with this array. To keep any existing item
|
|
2499
2499
|
* lines, you must include them in this array even if they have not changed.
|
|
2500
2500
|
* **Any item lines not included will be removed.**
|
|
2501
2501
|
*
|
|
@@ -2504,11 +2504,11 @@ export namespace BillUpdateParams {
|
|
|
2504
2504
|
* 3. If you do not wish to modify any item lines, omit this field entirely to keep
|
|
2505
2505
|
* them unchanged.
|
|
2506
2506
|
*/
|
|
2507
|
-
itemLines?: Array<
|
|
2507
|
+
itemLines?: Array<ItemGroupLine.ItemLine>;
|
|
2508
2508
|
|
|
2509
2509
|
/**
|
|
2510
|
-
* Specifies an alternative unit-of-measure set when updating this item
|
|
2511
|
-
*
|
|
2510
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
2511
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
2512
2512
|
* select units from a different set than the item's default unit-of-measure set,
|
|
2513
2513
|
* which remains unchanged on the item itself. The override applies only to this
|
|
2514
2514
|
* specific line. For example, you can sell an item typically measured in volume
|
|
@@ -2518,7 +2518,7 @@ export namespace BillUpdateParams {
|
|
|
2518
2518
|
overrideUnitOfMeasureSetId?: string;
|
|
2519
2519
|
|
|
2520
2520
|
/**
|
|
2521
|
-
* The quantity of the item group associated with this item line
|
|
2521
|
+
* The quantity of the item group associated with this item group line. This field
|
|
2522
2522
|
* cannot be cleared.
|
|
2523
2523
|
*
|
|
2524
2524
|
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
@@ -2527,13 +2527,13 @@ export namespace BillUpdateParams {
|
|
|
2527
2527
|
quantity?: number;
|
|
2528
2528
|
|
|
2529
2529
|
/**
|
|
2530
|
-
* The unit-of-measure used for the `quantity` in this item line
|
|
2530
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
2531
2531
|
* valid unit within the item's available units of measure.
|
|
2532
2532
|
*/
|
|
2533
2533
|
unitOfMeasure?: string;
|
|
2534
2534
|
}
|
|
2535
2535
|
|
|
2536
|
-
export namespace
|
|
2536
|
+
export namespace ItemGroupLine {
|
|
2537
2537
|
export interface ItemLine {
|
|
2538
2538
|
/**
|
|
2539
2539
|
* The QuickBooks-assigned unique identifier of an existing item line you wish to
|