conductor-node 14.18.0 → 14.20.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 +17 -0
- package/package.json +1 -1
- package/resources/end-users.d.mts +15 -4
- package/resources/end-users.d.mts.map +1 -1
- package/resources/end-users.d.ts +15 -4
- package/resources/end-users.d.ts.map +1 -1
- package/resources/end-users.js +9 -2
- package/resources/end-users.js.map +1 -1
- package/resources/end-users.mjs +9 -2
- package/resources/end-users.mjs.map +1 -1
- package/resources/qbd/bill-check-payments.d.mts +1 -1
- package/resources/qbd/bill-check-payments.d.ts +1 -1
- package/resources/qbd/bill-check-payments.js +1 -1
- package/resources/qbd/bill-check-payments.mjs +1 -1
- package/resources/qbd/bill-credit-card-payments.d.mts +1 -1
- package/resources/qbd/bill-credit-card-payments.d.ts +1 -1
- package/resources/qbd/bill-credit-card-payments.js +1 -1
- package/resources/qbd/bill-credit-card-payments.mjs +1 -1
- package/resources/qbd/bills.d.mts +1 -1
- package/resources/qbd/bills.d.ts +1 -1
- package/resources/qbd/bills.js +1 -1
- package/resources/qbd/bills.mjs +1 -1
- package/resources/qbd/build-assemblies.d.mts +1 -1
- package/resources/qbd/build-assemblies.d.ts +1 -1
- package/resources/qbd/build-assemblies.js +1 -1
- package/resources/qbd/build-assemblies.mjs +1 -1
- package/resources/qbd/checks.d.mts +2 -2
- package/resources/qbd/checks.d.ts +2 -2
- package/resources/qbd/checks.js +2 -2
- package/resources/qbd/checks.mjs +2 -2
- package/resources/qbd/credit-card-charges.d.mts +1 -1
- package/resources/qbd/credit-card-charges.d.ts +1 -1
- package/resources/qbd/credit-card-charges.js +1 -1
- package/resources/qbd/credit-card-charges.mjs +1 -1
- package/resources/qbd/credit-card-credits.d.mts +1 -1
- package/resources/qbd/credit-card-credits.d.ts +1 -1
- package/resources/qbd/credit-card-credits.js +1 -1
- package/resources/qbd/credit-card-credits.mjs +1 -1
- package/resources/qbd/credit-card-refunds.d.mts +1 -1
- package/resources/qbd/credit-card-refunds.d.ts +1 -1
- package/resources/qbd/credit-card-refunds.js +1 -1
- package/resources/qbd/credit-card-refunds.mjs +1 -1
- package/resources/qbd/credit-memos.d.mts +2 -2
- package/resources/qbd/credit-memos.d.ts +2 -2
- package/resources/qbd/credit-memos.js +2 -2
- package/resources/qbd/credit-memos.mjs +2 -2
- package/resources/qbd/deposits.d.mts +1 -1
- package/resources/qbd/deposits.d.ts +1 -1
- package/resources/qbd/deposits.js +1 -1
- package/resources/qbd/deposits.mjs +1 -1
- package/resources/qbd/estimates.d.mts +1 -1
- package/resources/qbd/estimates.d.ts +1 -1
- package/resources/qbd/estimates.js +1 -1
- package/resources/qbd/estimates.mjs +1 -1
- package/resources/qbd/index.d.mts +2 -0
- package/resources/qbd/index.d.mts.map +1 -1
- package/resources/qbd/index.d.ts +2 -0
- package/resources/qbd/index.d.ts.map +1 -1
- package/resources/qbd/index.js +6 -2
- package/resources/qbd/index.js.map +1 -1
- package/resources/qbd/index.mjs +2 -0
- package/resources/qbd/index.mjs.map +1 -1
- package/resources/qbd/inventory-adjustments.d.mts +1 -1
- package/resources/qbd/inventory-adjustments.d.ts +1 -1
- package/resources/qbd/inventory-adjustments.js +1 -1
- package/resources/qbd/inventory-adjustments.mjs +1 -1
- package/resources/qbd/invoices.d.mts +1 -1
- package/resources/qbd/invoices.d.ts +1 -1
- package/resources/qbd/invoices.js +1 -1
- package/resources/qbd/invoices.mjs +1 -1
- package/resources/qbd/item-receipts.d.mts +2 -2
- package/resources/qbd/item-receipts.d.ts +2 -2
- package/resources/qbd/item-receipts.js +2 -2
- package/resources/qbd/item-receipts.mjs +2 -2
- package/resources/qbd/journal-entries.d.mts +2 -2
- package/resources/qbd/journal-entries.d.ts +2 -2
- package/resources/qbd/journal-entries.js +2 -2
- package/resources/qbd/journal-entries.mjs +2 -2
- package/resources/qbd/purchase-orders.d.mts +1 -1
- package/resources/qbd/purchase-orders.d.ts +1 -1
- package/resources/qbd/purchase-orders.js +1 -1
- package/resources/qbd/purchase-orders.mjs +1 -1
- package/resources/qbd/qbd.d.mts +8 -0
- package/resources/qbd/qbd.d.mts.map +1 -1
- package/resources/qbd/qbd.d.ts +8 -0
- package/resources/qbd/qbd.d.ts.map +1 -1
- package/resources/qbd/qbd.js +8 -0
- package/resources/qbd/qbd.js.map +1 -1
- package/resources/qbd/qbd.mjs +8 -0
- package/resources/qbd/qbd.mjs.map +1 -1
- package/resources/qbd/receive-payments.d.mts +1 -1
- package/resources/qbd/receive-payments.d.ts +1 -1
- package/resources/qbd/receive-payments.js +1 -1
- package/resources/qbd/receive-payments.mjs +1 -1
- package/resources/qbd/sales-orders.d.mts +2 -2
- package/resources/qbd/sales-orders.d.ts +2 -2
- package/resources/qbd/sales-orders.js +2 -2
- package/resources/qbd/sales-orders.mjs +2 -2
- package/resources/qbd/sales-receipts.d.mts +2 -2
- package/resources/qbd/sales-receipts.d.ts +2 -2
- package/resources/qbd/sales-receipts.js +2 -2
- package/resources/qbd/sales-receipts.mjs +2 -2
- package/resources/qbd/sales-tax-group-items.d.mts +417 -0
- package/resources/qbd/sales-tax-group-items.d.mts.map +1 -0
- package/resources/qbd/sales-tax-group-items.d.ts +417 -0
- package/resources/qbd/sales-tax-group-items.d.ts.map +1 -0
- package/resources/qbd/sales-tax-group-items.js +102 -0
- package/resources/qbd/sales-tax-group-items.js.map +1 -0
- package/resources/qbd/sales-tax-group-items.mjs +98 -0
- package/resources/qbd/sales-tax-group-items.mjs.map +1 -0
- package/resources/qbd/sales-tax-payment-checks.d.mts +809 -0
- package/resources/qbd/sales-tax-payment-checks.d.mts.map +1 -0
- package/resources/qbd/sales-tax-payment-checks.d.ts +809 -0
- package/resources/qbd/sales-tax-payment-checks.d.ts.map +1 -0
- package/resources/qbd/sales-tax-payment-checks.js +146 -0
- package/resources/qbd/sales-tax-payment-checks.js.map +1 -0
- package/resources/qbd/sales-tax-payment-checks.mjs +142 -0
- package/resources/qbd/sales-tax-payment-checks.mjs.map +1 -0
- package/resources/qbd/time-tracking-activities.d.mts +3 -3
- package/resources/qbd/time-tracking-activities.d.ts +3 -3
- package/resources/qbd/time-tracking-activities.js +3 -3
- package/resources/qbd/time-tracking-activities.mjs +3 -3
- package/resources/qbd/vendor-credits.d.mts +2 -2
- package/resources/qbd/vendor-credits.d.ts +2 -2
- package/resources/qbd/vendor-credits.js +2 -2
- package/resources/qbd/vendor-credits.mjs +2 -2
- package/src/resources/end-users.ts +15 -4
- package/src/resources/qbd/bill-check-payments.ts +1 -1
- package/src/resources/qbd/bill-credit-card-payments.ts +1 -1
- package/src/resources/qbd/bills.ts +1 -1
- package/src/resources/qbd/build-assemblies.ts +1 -1
- package/src/resources/qbd/checks.ts +2 -2
- package/src/resources/qbd/credit-card-charges.ts +1 -1
- package/src/resources/qbd/credit-card-credits.ts +1 -1
- package/src/resources/qbd/credit-card-refunds.ts +1 -1
- package/src/resources/qbd/credit-memos.ts +2 -2
- package/src/resources/qbd/deposits.ts +1 -1
- package/src/resources/qbd/estimates.ts +1 -1
- package/src/resources/qbd/index.ts +22 -0
- package/src/resources/qbd/inventory-adjustments.ts +1 -1
- package/src/resources/qbd/invoices.ts +1 -1
- package/src/resources/qbd/item-receipts.ts +2 -2
- package/src/resources/qbd/journal-entries.ts +2 -2
- package/src/resources/qbd/purchase-orders.ts +1 -1
- package/src/resources/qbd/qbd.ts +55 -0
- package/src/resources/qbd/receive-payments.ts +1 -1
- package/src/resources/qbd/sales-orders.ts +2 -2
- package/src/resources/qbd/sales-receipts.ts +2 -2
- package/src/resources/qbd/sales-tax-group-items.ts +533 -0
- package/src/resources/qbd/sales-tax-payment-checks.ts +1014 -0
- package/src/resources/qbd/time-tracking-activities.ts +3 -3
- package/src/resources/qbd/vendor-credits.ts +2 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -117,8 +117,8 @@ export class JournalEntries extends APIResource {
|
|
|
117
117
|
}
|
|
118
118
|
|
|
119
119
|
/**
|
|
120
|
-
* Permanently deletes a
|
|
121
|
-
*
|
|
120
|
+
* Permanently deletes a journal entry. The deletion will fail if the journal entry
|
|
121
|
+
* is currently in use or has any linked transactions that are in use.
|
|
122
122
|
*
|
|
123
123
|
* @example
|
|
124
124
|
* ```ts
|
|
@@ -114,7 +114,7 @@ export class PurchaseOrders extends APIResource {
|
|
|
114
114
|
}
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* Permanently deletes a
|
|
117
|
+
* Permanently deletes a purchase order. The deletion will fail if the purchase
|
|
118
118
|
* order is currently in use or has any linked transactions that are in use.
|
|
119
119
|
*
|
|
120
120
|
* @example
|
package/src/resources/qbd/qbd.ts
CHANGED
|
@@ -508,6 +508,16 @@ import {
|
|
|
508
508
|
SalesTaxCodeUpdateParams,
|
|
509
509
|
SalesTaxCodes,
|
|
510
510
|
} from './sales-tax-codes';
|
|
511
|
+
import * as SalesTaxGroupItemsAPI from './sales-tax-group-items';
|
|
512
|
+
import {
|
|
513
|
+
SalesTaxGroupItem,
|
|
514
|
+
SalesTaxGroupItemCreateParams,
|
|
515
|
+
SalesTaxGroupItemListParams,
|
|
516
|
+
SalesTaxGroupItemRetrieveParams,
|
|
517
|
+
SalesTaxGroupItemUpdateParams,
|
|
518
|
+
SalesTaxGroupItems,
|
|
519
|
+
SalesTaxGroupItemsCursorPage,
|
|
520
|
+
} from './sales-tax-group-items';
|
|
511
521
|
import * as SalesTaxItemsAPI from './sales-tax-items';
|
|
512
522
|
import {
|
|
513
523
|
SalesTaxItem,
|
|
@@ -518,6 +528,20 @@ import {
|
|
|
518
528
|
SalesTaxItems,
|
|
519
529
|
SalesTaxItemsCursorPage,
|
|
520
530
|
} from './sales-tax-items';
|
|
531
|
+
import * as SalesTaxPaymentChecksAPI from './sales-tax-payment-checks';
|
|
532
|
+
import {
|
|
533
|
+
SalesTaxPaymentCheck,
|
|
534
|
+
SalesTaxPaymentCheckCreateParams,
|
|
535
|
+
SalesTaxPaymentCheckDeleteParams,
|
|
536
|
+
SalesTaxPaymentCheckDeleteResponse,
|
|
537
|
+
SalesTaxPaymentCheckListParams,
|
|
538
|
+
SalesTaxPaymentCheckRetrieveParams,
|
|
539
|
+
SalesTaxPaymentCheckUpdateParams,
|
|
540
|
+
SalesTaxPaymentCheckVoidParams,
|
|
541
|
+
SalesTaxPaymentCheckVoidResponse,
|
|
542
|
+
SalesTaxPaymentChecks,
|
|
543
|
+
SalesTaxPaymentChecksCursorPage,
|
|
544
|
+
} from './sales-tax-payment-checks';
|
|
521
545
|
import * as ServiceItemsAPI from './service-items';
|
|
522
546
|
import {
|
|
523
547
|
ServiceItem,
|
|
@@ -697,7 +721,12 @@ export class Qbd extends APIResource {
|
|
|
697
721
|
salesRepresentatives: SalesRepresentativesAPI.SalesRepresentatives =
|
|
698
722
|
new SalesRepresentativesAPI.SalesRepresentatives(this._client);
|
|
699
723
|
salesTaxCodes: SalesTaxCodesAPI.SalesTaxCodes = new SalesTaxCodesAPI.SalesTaxCodes(this._client);
|
|
724
|
+
salesTaxGroupItems: SalesTaxGroupItemsAPI.SalesTaxGroupItems = new SalesTaxGroupItemsAPI.SalesTaxGroupItems(
|
|
725
|
+
this._client,
|
|
726
|
+
);
|
|
700
727
|
salesTaxItems: SalesTaxItemsAPI.SalesTaxItems = new SalesTaxItemsAPI.SalesTaxItems(this._client);
|
|
728
|
+
salesTaxPaymentChecks: SalesTaxPaymentChecksAPI.SalesTaxPaymentChecks =
|
|
729
|
+
new SalesTaxPaymentChecksAPI.SalesTaxPaymentChecks(this._client);
|
|
701
730
|
serviceItems: ServiceItemsAPI.ServiceItems = new ServiceItemsAPI.ServiceItems(this._client);
|
|
702
731
|
shippingMethods: ShippingMethodsAPI.ShippingMethods = new ShippingMethodsAPI.ShippingMethods(this._client);
|
|
703
732
|
standardTerms: StandardTermsAPI.StandardTerms = new StandardTermsAPI.StandardTerms(this._client);
|
|
@@ -803,7 +832,9 @@ Qbd.SalesOrders = SalesOrders;
|
|
|
803
832
|
Qbd.SalesReceipts = SalesReceipts;
|
|
804
833
|
Qbd.SalesRepresentatives = SalesRepresentatives;
|
|
805
834
|
Qbd.SalesTaxCodes = SalesTaxCodes;
|
|
835
|
+
Qbd.SalesTaxGroupItems = SalesTaxGroupItems;
|
|
806
836
|
Qbd.SalesTaxItems = SalesTaxItems;
|
|
837
|
+
Qbd.SalesTaxPaymentChecks = SalesTaxPaymentChecks;
|
|
807
838
|
Qbd.ServiceItems = ServiceItems;
|
|
808
839
|
Qbd.ShippingMethods = ShippingMethods;
|
|
809
840
|
Qbd.StandardTerms = StandardTerms;
|
|
@@ -1338,6 +1369,16 @@ export declare namespace Qbd {
|
|
|
1338
1369
|
type SalesTaxCodeListParams as SalesTaxCodeListParams,
|
|
1339
1370
|
};
|
|
1340
1371
|
|
|
1372
|
+
export {
|
|
1373
|
+
SalesTaxGroupItems as SalesTaxGroupItems,
|
|
1374
|
+
type SalesTaxGroupItem as SalesTaxGroupItem,
|
|
1375
|
+
type SalesTaxGroupItemsCursorPage as SalesTaxGroupItemsCursorPage,
|
|
1376
|
+
type SalesTaxGroupItemCreateParams as SalesTaxGroupItemCreateParams,
|
|
1377
|
+
type SalesTaxGroupItemRetrieveParams as SalesTaxGroupItemRetrieveParams,
|
|
1378
|
+
type SalesTaxGroupItemUpdateParams as SalesTaxGroupItemUpdateParams,
|
|
1379
|
+
type SalesTaxGroupItemListParams as SalesTaxGroupItemListParams,
|
|
1380
|
+
};
|
|
1381
|
+
|
|
1341
1382
|
export {
|
|
1342
1383
|
SalesTaxItems as SalesTaxItems,
|
|
1343
1384
|
type SalesTaxItem as SalesTaxItem,
|
|
@@ -1348,6 +1389,20 @@ export declare namespace Qbd {
|
|
|
1348
1389
|
type SalesTaxItemListParams as SalesTaxItemListParams,
|
|
1349
1390
|
};
|
|
1350
1391
|
|
|
1392
|
+
export {
|
|
1393
|
+
SalesTaxPaymentChecks as SalesTaxPaymentChecks,
|
|
1394
|
+
type SalesTaxPaymentCheck as SalesTaxPaymentCheck,
|
|
1395
|
+
type SalesTaxPaymentCheckDeleteResponse as SalesTaxPaymentCheckDeleteResponse,
|
|
1396
|
+
type SalesTaxPaymentCheckVoidResponse as SalesTaxPaymentCheckVoidResponse,
|
|
1397
|
+
type SalesTaxPaymentChecksCursorPage as SalesTaxPaymentChecksCursorPage,
|
|
1398
|
+
type SalesTaxPaymentCheckCreateParams as SalesTaxPaymentCheckCreateParams,
|
|
1399
|
+
type SalesTaxPaymentCheckRetrieveParams as SalesTaxPaymentCheckRetrieveParams,
|
|
1400
|
+
type SalesTaxPaymentCheckUpdateParams as SalesTaxPaymentCheckUpdateParams,
|
|
1401
|
+
type SalesTaxPaymentCheckListParams as SalesTaxPaymentCheckListParams,
|
|
1402
|
+
type SalesTaxPaymentCheckDeleteParams as SalesTaxPaymentCheckDeleteParams,
|
|
1403
|
+
type SalesTaxPaymentCheckVoidParams as SalesTaxPaymentCheckVoidParams,
|
|
1404
|
+
};
|
|
1405
|
+
|
|
1351
1406
|
export {
|
|
1352
1407
|
ServiceItems as ServiceItems,
|
|
1353
1408
|
type ServiceItem as ServiceItem,
|
|
@@ -120,7 +120,7 @@ export class ReceivePayments extends APIResource {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* Permanently deletes a
|
|
123
|
+
* Permanently deletes a receive-payment. The deletion will fail if the
|
|
124
124
|
* receive-payment is currently in use or has any linked transactions that are in
|
|
125
125
|
* use.
|
|
126
126
|
*
|
|
@@ -108,8 +108,8 @@ export class SalesOrders extends APIResource {
|
|
|
108
108
|
}
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
* Permanently deletes a
|
|
112
|
-
*
|
|
111
|
+
* Permanently deletes a sales order. The deletion will fail if the sales order is
|
|
112
|
+
* currently in use or has any linked transactions that are in use.
|
|
113
113
|
*
|
|
114
114
|
* @example
|
|
115
115
|
* ```ts
|
|
@@ -117,8 +117,8 @@ export class SalesReceipts extends APIResource {
|
|
|
117
117
|
}
|
|
118
118
|
|
|
119
119
|
/**
|
|
120
|
-
* Permanently deletes a
|
|
121
|
-
*
|
|
120
|
+
* Permanently deletes a sales receipt. The deletion will fail if the sales receipt
|
|
121
|
+
* is currently in use or has any linked transactions that are in use.
|
|
122
122
|
*
|
|
123
123
|
* @example
|
|
124
124
|
* ```ts
|
|
@@ -0,0 +1,533 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../core/resource';
|
|
4
|
+
import { APIPromise } from '../../core/api-promise';
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
|
|
6
|
+
import { buildHeaders } from '../../internal/headers';
|
|
7
|
+
import { RequestOptions } from '../../internal/request-options';
|
|
8
|
+
import { path } from '../../internal/utils/path';
|
|
9
|
+
|
|
10
|
+
export class SalesTaxGroupItems extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Creates a new sales-tax group item.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const salesTaxGroupItem =
|
|
17
|
+
* await conductor.qbd.salesTaxGroupItems.create({
|
|
18
|
+
* name: 'Standard Tax Group',
|
|
19
|
+
* salesTaxItemIds: ['80000001-1234567890'],
|
|
20
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
create(params: SalesTaxGroupItemCreateParams, options?: RequestOptions): APIPromise<SalesTaxGroupItem> {
|
|
25
|
+
const { conductorEndUserId, ...body } = params;
|
|
26
|
+
return this._client.post('/quickbooks-desktop/sales-tax-group-items', {
|
|
27
|
+
body,
|
|
28
|
+
...options,
|
|
29
|
+
headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Retrieves a sales-tax group item by ID.
|
|
35
|
+
*
|
|
36
|
+
* **IMPORTANT:** If you need to fetch multiple specific sales-tax group items by
|
|
37
|
+
* ID, use the list endpoint instead with the `ids` parameter. It accepts an array
|
|
38
|
+
* of IDs so you can batch the request into a single call, which is significantly
|
|
39
|
+
* faster.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const salesTaxGroupItem =
|
|
44
|
+
* await conductor.qbd.salesTaxGroupItems.retrieve(
|
|
45
|
+
* '80000001-1234567890',
|
|
46
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
47
|
+
* );
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
retrieve(
|
|
51
|
+
id: string,
|
|
52
|
+
params: SalesTaxGroupItemRetrieveParams,
|
|
53
|
+
options?: RequestOptions,
|
|
54
|
+
): APIPromise<SalesTaxGroupItem> {
|
|
55
|
+
const { conductorEndUserId } = params;
|
|
56
|
+
return this._client.get(path`/quickbooks-desktop/sales-tax-group-items/${id}`, {
|
|
57
|
+
...options,
|
|
58
|
+
headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Updates an existing sales-tax group item.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const salesTaxGroupItem =
|
|
68
|
+
* await conductor.qbd.salesTaxGroupItems.update(
|
|
69
|
+
* '80000001-1234567890',
|
|
70
|
+
* {
|
|
71
|
+
* revisionNumber: '1721172183',
|
|
72
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
73
|
+
* },
|
|
74
|
+
* );
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
update(
|
|
78
|
+
id: string,
|
|
79
|
+
params: SalesTaxGroupItemUpdateParams,
|
|
80
|
+
options?: RequestOptions,
|
|
81
|
+
): APIPromise<SalesTaxGroupItem> {
|
|
82
|
+
const { conductorEndUserId, ...body } = params;
|
|
83
|
+
return this._client.post(path`/quickbooks-desktop/sales-tax-group-items/${id}`, {
|
|
84
|
+
body,
|
|
85
|
+
...options,
|
|
86
|
+
headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Returns a list of sales-tax group items. Use the `cursor` parameter to paginate
|
|
92
|
+
* through the results.
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* // Automatically fetches more pages as needed.
|
|
97
|
+
* for await (const salesTaxGroupItem of conductor.qbd.salesTaxGroupItems.list(
|
|
98
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
99
|
+
* )) {
|
|
100
|
+
* // ...
|
|
101
|
+
* }
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
list(
|
|
105
|
+
params: SalesTaxGroupItemListParams,
|
|
106
|
+
options?: RequestOptions,
|
|
107
|
+
): PagePromise<SalesTaxGroupItemsCursorPage, SalesTaxGroupItem> {
|
|
108
|
+
const { conductorEndUserId, ...query } = params;
|
|
109
|
+
return this._client.getAPIList(
|
|
110
|
+
'/quickbooks-desktop/sales-tax-group-items',
|
|
111
|
+
CursorPage<SalesTaxGroupItem>,
|
|
112
|
+
{
|
|
113
|
+
query,
|
|
114
|
+
...options,
|
|
115
|
+
headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
|
|
116
|
+
},
|
|
117
|
+
);
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export type SalesTaxGroupItemsCursorPage = CursorPage<SalesTaxGroupItem>;
|
|
122
|
+
|
|
123
|
+
export interface SalesTaxGroupItem {
|
|
124
|
+
/**
|
|
125
|
+
* The unique identifier assigned by QuickBooks to this sales-tax group item. This
|
|
126
|
+
* ID is unique across all sales-tax group items but not across different
|
|
127
|
+
* QuickBooks object types.
|
|
128
|
+
*/
|
|
129
|
+
id: string;
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* The sales-tax group item's barcode.
|
|
133
|
+
*/
|
|
134
|
+
barcode: string | null;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* The date and time when this sales-tax group item was created, in ISO 8601 format
|
|
138
|
+
* (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
|
|
139
|
+
* timezone of the end-user's computer.
|
|
140
|
+
*/
|
|
141
|
+
createdAt: string;
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* The custom fields for the sales-tax group item object, added as user-defined
|
|
145
|
+
* data extensions, not included in the standard QuickBooks object.
|
|
146
|
+
*/
|
|
147
|
+
customFields: Array<SalesTaxGroupItem.CustomField>;
|
|
148
|
+
|
|
149
|
+
/**
|
|
150
|
+
* The sales-tax group item's description that will appear on sales forms that
|
|
151
|
+
* include this item.
|
|
152
|
+
*/
|
|
153
|
+
description: string | null;
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* A globally unique identifier (GUID) you, the developer, can provide for tracking
|
|
157
|
+
* this object in your external system. This field is immutable and can only be set
|
|
158
|
+
* during object creation.
|
|
159
|
+
*/
|
|
160
|
+
externalId: string | null;
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Indicates whether this sales-tax group item is active. Inactive objects are
|
|
164
|
+
* typically hidden from views and reports in QuickBooks. Defaults to `true`.
|
|
165
|
+
*/
|
|
166
|
+
isActive: boolean;
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* The case-insensitive unique name of this sales-tax group item, unique across all
|
|
170
|
+
* sales-tax group items.
|
|
171
|
+
*
|
|
172
|
+
* **NOTE**: Sales-tax group items do not have a `fullName` field because they are
|
|
173
|
+
* not hierarchical objects, which is why `name` is unique for them but not for
|
|
174
|
+
* objects that have parents.
|
|
175
|
+
*/
|
|
176
|
+
name: string;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* The type of object. This value is always `"qbd_sales_tax_group_item"`.
|
|
180
|
+
*/
|
|
181
|
+
objectType: 'qbd_sales_tax_group_item';
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* The current QuickBooks-assigned revision number of this sales-tax group item
|
|
185
|
+
* object, which changes each time the object is modified. When updating this
|
|
186
|
+
* object, you must provide the most recent `revisionNumber` to ensure you're
|
|
187
|
+
* working with the latest data; otherwise, the update will return an error.
|
|
188
|
+
*/
|
|
189
|
+
revisionNumber: string;
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* The sales-tax items that make up this sales-tax group item. QuickBooks Desktop
|
|
193
|
+
* applies these sales-tax items together as one tax selection while tracking each
|
|
194
|
+
* sales tax separately.
|
|
195
|
+
*/
|
|
196
|
+
salesTaxItems: Array<SalesTaxGroupItem.SalesTaxItem>;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* The date and time when this sales-tax group item was last updated, in ISO 8601
|
|
200
|
+
* format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the
|
|
201
|
+
* local timezone of the end-user's computer.
|
|
202
|
+
*/
|
|
203
|
+
updatedAt: string;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
export namespace SalesTaxGroupItem {
|
|
207
|
+
export interface CustomField {
|
|
208
|
+
/**
|
|
209
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
210
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
211
|
+
*/
|
|
212
|
+
name: string;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
216
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
217
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
218
|
+
* fields that are only visible to the application that created them, this is a
|
|
219
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
220
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
221
|
+
* objects.
|
|
222
|
+
*/
|
|
223
|
+
ownerId: string;
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* The data type of this custom field.
|
|
227
|
+
*/
|
|
228
|
+
type:
|
|
229
|
+
| 'amount_type'
|
|
230
|
+
| 'date_time_type'
|
|
231
|
+
| 'integer_type'
|
|
232
|
+
| 'percent_type'
|
|
233
|
+
| 'price_type'
|
|
234
|
+
| 'quantity_type'
|
|
235
|
+
| 'string_1024_type'
|
|
236
|
+
| 'string_255_type';
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
240
|
+
* type.
|
|
241
|
+
*/
|
|
242
|
+
value: string;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
export interface SalesTaxItem {
|
|
246
|
+
/**
|
|
247
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
248
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
249
|
+
* types.
|
|
250
|
+
*/
|
|
251
|
+
id: string | null;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
255
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
256
|
+
* case-sensitive.
|
|
257
|
+
*/
|
|
258
|
+
fullName: string | null;
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
export interface SalesTaxGroupItemCreateParams {
|
|
263
|
+
/**
|
|
264
|
+
* Body param: The case-insensitive unique name of this sales-tax group item,
|
|
265
|
+
* unique across all sales-tax group items.
|
|
266
|
+
*
|
|
267
|
+
* **NOTE**: Sales-tax group items do not have a `fullName` field because they are
|
|
268
|
+
* not hierarchical objects, which is why `name` is unique for them but not for
|
|
269
|
+
* objects that have parents.
|
|
270
|
+
*
|
|
271
|
+
* Maximum length: 31 characters.
|
|
272
|
+
*/
|
|
273
|
+
name: string;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Body param: The sales-tax items that make up this sales-tax group item.
|
|
277
|
+
* QuickBooks Desktop applies these sales-tax items together as one tax selection
|
|
278
|
+
* while tracking each sales tax separately.
|
|
279
|
+
*/
|
|
280
|
+
salesTaxItemIds: Array<string>;
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* Header param: The ID of the End-User to receive this request.
|
|
284
|
+
*/
|
|
285
|
+
conductorEndUserId: string;
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* Body param: The sales-tax group item's barcode.
|
|
289
|
+
*/
|
|
290
|
+
barcode?: SalesTaxGroupItemCreateParams.Barcode;
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* Body param: The sales-tax group item's description that will appear on sales
|
|
294
|
+
* forms that include this item.
|
|
295
|
+
*/
|
|
296
|
+
description?: string;
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Body param: A globally unique identifier (GUID) you, the developer, can provide
|
|
300
|
+
* for tracking this object in your external system. This field is immutable and
|
|
301
|
+
* can only be set during object creation.
|
|
302
|
+
*
|
|
303
|
+
* **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
|
|
304
|
+
* QuickBooks will return an error.
|
|
305
|
+
*/
|
|
306
|
+
externalId?: string;
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* Body param: Indicates whether this sales-tax group item is active. Inactive
|
|
310
|
+
* objects are typically hidden from views and reports in QuickBooks. Defaults to
|
|
311
|
+
* `true`.
|
|
312
|
+
*/
|
|
313
|
+
isActive?: boolean;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
export namespace SalesTaxGroupItemCreateParams {
|
|
317
|
+
/**
|
|
318
|
+
* The sales-tax group item's barcode.
|
|
319
|
+
*/
|
|
320
|
+
export interface Barcode {
|
|
321
|
+
/**
|
|
322
|
+
* Indicates whether to allow the barcode to be overridden.
|
|
323
|
+
*/
|
|
324
|
+
allowOverride?: boolean;
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Indicates whether to assign the barcode even if it is already used.
|
|
328
|
+
*/
|
|
329
|
+
assignEvenIfUsed?: boolean;
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* The item's barcode value.
|
|
333
|
+
*/
|
|
334
|
+
value?: string;
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
export interface SalesTaxGroupItemRetrieveParams {
|
|
339
|
+
/**
|
|
340
|
+
* The ID of the End-User to receive this request.
|
|
341
|
+
*/
|
|
342
|
+
conductorEndUserId: string;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
export interface SalesTaxGroupItemUpdateParams {
|
|
346
|
+
/**
|
|
347
|
+
* Body param: The current QuickBooks-assigned revision number of the sales-tax
|
|
348
|
+
* group item object you are updating, which you can get by fetching the object
|
|
349
|
+
* first. Provide the most recent `revisionNumber` to ensure you're working with
|
|
350
|
+
* the latest data; otherwise, the update will return an error.
|
|
351
|
+
*/
|
|
352
|
+
revisionNumber: string;
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Header param: The ID of the End-User to receive this request.
|
|
356
|
+
*/
|
|
357
|
+
conductorEndUserId: string;
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
* Body param: The sales-tax group item's barcode.
|
|
361
|
+
*/
|
|
362
|
+
barcode?: SalesTaxGroupItemUpdateParams.Barcode;
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Body param: The sales-tax group item's description that will appear on sales
|
|
366
|
+
* forms that include this item.
|
|
367
|
+
*/
|
|
368
|
+
description?: string;
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* Body param: Indicates whether this sales-tax group item is active. Inactive
|
|
372
|
+
* objects are typically hidden from views and reports in QuickBooks. Defaults to
|
|
373
|
+
* `true`.
|
|
374
|
+
*/
|
|
375
|
+
isActive?: boolean;
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* Body param: The case-insensitive unique name of this sales-tax group item,
|
|
379
|
+
* unique across all sales-tax group items.
|
|
380
|
+
*
|
|
381
|
+
* **NOTE**: Sales-tax group items do not have a `fullName` field because they are
|
|
382
|
+
* not hierarchical objects, which is why `name` is unique for them but not for
|
|
383
|
+
* objects that have parents.
|
|
384
|
+
*
|
|
385
|
+
* Maximum length: 31 characters.
|
|
386
|
+
*/
|
|
387
|
+
name?: string;
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* Body param: The sales-tax items that make up this sales-tax group item.
|
|
391
|
+
* QuickBooks Desktop applies these sales-tax items together as one tax selection
|
|
392
|
+
* while tracking each sales tax separately.
|
|
393
|
+
*/
|
|
394
|
+
salesTaxItemIds?: Array<string>;
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
export namespace SalesTaxGroupItemUpdateParams {
|
|
398
|
+
/**
|
|
399
|
+
* The sales-tax group item's barcode.
|
|
400
|
+
*/
|
|
401
|
+
export interface Barcode {
|
|
402
|
+
/**
|
|
403
|
+
* Indicates whether to allow the barcode to be overridden.
|
|
404
|
+
*/
|
|
405
|
+
allowOverride?: boolean;
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* Indicates whether to assign the barcode even if it is already used.
|
|
409
|
+
*/
|
|
410
|
+
assignEvenIfUsed?: boolean;
|
|
411
|
+
|
|
412
|
+
/**
|
|
413
|
+
* The item's barcode value.
|
|
414
|
+
*/
|
|
415
|
+
value?: string;
|
|
416
|
+
}
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
export interface SalesTaxGroupItemListParams extends CursorPageParams {
|
|
420
|
+
/**
|
|
421
|
+
* Header param: The ID of the End-User to receive this request.
|
|
422
|
+
*/
|
|
423
|
+
conductorEndUserId: string;
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* Query param: Filter for specific sales-tax group items by their
|
|
427
|
+
* QuickBooks-assigned unique identifier(s).
|
|
428
|
+
*
|
|
429
|
+
* **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
|
|
430
|
+
* query parameters for this request.
|
|
431
|
+
*
|
|
432
|
+
* **NOTE**: If any of the values you specify in this parameter are not found, the
|
|
433
|
+
* request will return an error.
|
|
434
|
+
*/
|
|
435
|
+
ids?: Array<string>;
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* Query param: Filter for sales-tax group items whose `name` contains this
|
|
439
|
+
* substring, case-insensitive.
|
|
440
|
+
*
|
|
441
|
+
* **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or
|
|
442
|
+
* `nameEndsWith`.
|
|
443
|
+
*/
|
|
444
|
+
nameContains?: string;
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Query param: Filter for sales-tax group items whose `name` ends with this
|
|
448
|
+
* substring, case-insensitive.
|
|
449
|
+
*
|
|
450
|
+
* **NOTE**: If you use this parameter, you cannot also use `nameContains` or
|
|
451
|
+
* `nameStartsWith`.
|
|
452
|
+
*/
|
|
453
|
+
nameEndsWith?: string;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Query param: Filter for sales-tax group items whose `name` is alphabetically
|
|
457
|
+
* greater than or equal to this value.
|
|
458
|
+
*/
|
|
459
|
+
nameFrom?: string;
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* Query param: Filter for specific sales-tax group items by their name(s),
|
|
463
|
+
* case-insensitive. Like `id`, `name` is a unique identifier for a sales-tax group
|
|
464
|
+
* item.
|
|
465
|
+
*
|
|
466
|
+
* **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
|
|
467
|
+
* query parameters for this request.
|
|
468
|
+
*
|
|
469
|
+
* **NOTE**: If any of the values you specify in this parameter are not found, the
|
|
470
|
+
* request will return an error.
|
|
471
|
+
*/
|
|
472
|
+
names?: Array<string>;
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* Query param: Filter for sales-tax group items whose `name` starts with this
|
|
476
|
+
* substring, case-insensitive.
|
|
477
|
+
*
|
|
478
|
+
* **NOTE**: If you use this parameter, you cannot also use `nameContains` or
|
|
479
|
+
* `nameEndsWith`.
|
|
480
|
+
*/
|
|
481
|
+
nameStartsWith?: string;
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* Query param: Filter for sales-tax group items whose `name` is alphabetically
|
|
485
|
+
* less than or equal to this value.
|
|
486
|
+
*/
|
|
487
|
+
nameTo?: string;
|
|
488
|
+
|
|
489
|
+
/**
|
|
490
|
+
* Query param: Filter for sales-tax group items that are active, inactive, or
|
|
491
|
+
* both.
|
|
492
|
+
*/
|
|
493
|
+
status?: 'active' | 'all' | 'inactive';
|
|
494
|
+
|
|
495
|
+
/**
|
|
496
|
+
* Query param: Filter for sales-tax group items updated on or after this
|
|
497
|
+
* date/time. Accepts the following ISO 8601 formats:
|
|
498
|
+
*
|
|
499
|
+
* - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
|
|
500
|
+
* **start of the specified day** in the local timezone of the end-user's
|
|
501
|
+
* computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
|
|
502
|
+
* - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
|
|
503
|
+
* interprets the timestamp in the local timezone of the end-user's computer.
|
|
504
|
+
* - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
|
|
505
|
+
* interprets the timestamp using the specified timezone.
|
|
506
|
+
*/
|
|
507
|
+
updatedAfter?: string;
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Query param: Filter for sales-tax group items updated on or before this
|
|
511
|
+
* date/time. Accepts the following ISO 8601 formats:
|
|
512
|
+
*
|
|
513
|
+
* - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
|
|
514
|
+
* **end of the specified day** in the local timezone of the end-user's computer
|
|
515
|
+
* (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
|
|
516
|
+
* - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
|
|
517
|
+
* interprets the timestamp in the local timezone of the end-user's computer.
|
|
518
|
+
* - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
|
|
519
|
+
* interprets the timestamp using the specified timezone.
|
|
520
|
+
*/
|
|
521
|
+
updatedBefore?: string;
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
export declare namespace SalesTaxGroupItems {
|
|
525
|
+
export {
|
|
526
|
+
type SalesTaxGroupItem as SalesTaxGroupItem,
|
|
527
|
+
type SalesTaxGroupItemsCursorPage as SalesTaxGroupItemsCursorPage,
|
|
528
|
+
type SalesTaxGroupItemCreateParams as SalesTaxGroupItemCreateParams,
|
|
529
|
+
type SalesTaxGroupItemRetrieveParams as SalesTaxGroupItemRetrieveParams,
|
|
530
|
+
type SalesTaxGroupItemUpdateParams as SalesTaxGroupItemUpdateParams,
|
|
531
|
+
type SalesTaxGroupItemListParams as SalesTaxGroupItemListParams,
|
|
532
|
+
};
|
|
533
|
+
}
|