nxus-qbd 0.3.3 → 0.3.4
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/README.md +340 -252
- package/dist/client.d.ts +26 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +5 -1
- package/dist/client.js.map +1 -1
- package/dist/generated/types.gen.d.ts +128 -116
- package/dist/generated/types.gen.d.ts.map +1 -1
- package/dist/generated/types.gen.js.map +1 -1
- package/dist/transport.d.ts +78 -0
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +291 -20
- package/dist/transport.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export type ClientOptions = {
|
|
2
|
-
baseUrl: "https://
|
|
2
|
+
baseUrl: "https://api.nx-us.net/" | (string & {});
|
|
3
3
|
};
|
|
4
4
|
/**
|
|
5
5
|
* A QuickBooks Desktop Account object is a type of List object that represents a financial account within a company's chart of accounts, such as a Bank, Accounts Payable, Accounts Receivable, or Credit Card account Because it is a list object, it is tracked and identified by a unique, QuickBooks-assigned ListID as well as a FullName.
|
|
@@ -353,8 +353,12 @@ export type ApplyToTransactionRequest = {
|
|
|
353
353
|
*/
|
|
354
354
|
paymentAmount?: number | null;
|
|
355
355
|
/**
|
|
356
|
-
* List of credits to set/apply to this transaction.
|
|
357
|
-
*
|
|
356
|
+
* List of credits to set/apply to this transaction. (Optional)
|
|
357
|
+
* <remarks>
|
|
358
|
+
* QBD:
|
|
359
|
+
* - Setting/Applying a credit means using an available credit to lower the balance of a transaction such as an invoice or a bill.
|
|
360
|
+
* - Creating a credit, on the other hand, means making a credit available to be applied in the future.
|
|
361
|
+
* </remarks>
|
|
358
362
|
*/
|
|
359
363
|
appliedCredits?: Array<CreateSetCreditRequest> | null;
|
|
360
364
|
/**
|
|
@@ -615,10 +619,10 @@ export type BasePageResponseBill = {
|
|
|
615
619
|
* Simple paginated response designed for SDK consumption
|
|
616
620
|
* Clean, predictable structure perfect for automated pagination handling
|
|
617
621
|
*/
|
|
618
|
-
export type
|
|
622
|
+
export type BasePageResponseBillPaymentOrCredit = {
|
|
619
623
|
requestId?: string | null;
|
|
620
624
|
success?: boolean;
|
|
621
|
-
data?: Array<
|
|
625
|
+
data?: Array<BillPaymentOrCredit>;
|
|
622
626
|
nextCursor?: string;
|
|
623
627
|
page?: number;
|
|
624
628
|
count?: number;
|
|
@@ -636,10 +640,10 @@ export type BasePageResponseBillingRate = {
|
|
|
636
640
|
* Simple paginated response designed for SDK consumption
|
|
637
641
|
* Clean, predictable structure perfect for automated pagination handling
|
|
638
642
|
*/
|
|
639
|
-
export type
|
|
643
|
+
export type BasePageResponseBillingRate = {
|
|
640
644
|
requestId?: string | null;
|
|
641
645
|
success?: boolean;
|
|
642
|
-
data?: Array<
|
|
646
|
+
data?: Array<BillingRate>;
|
|
643
647
|
nextCursor?: string;
|
|
644
648
|
page?: number;
|
|
645
649
|
count?: number;
|
|
@@ -1892,6 +1896,19 @@ export type Bill = {
|
|
|
1892
1896
|
openAmount?: number | null;
|
|
1893
1897
|
customFields?: Array<QbdDataExt>;
|
|
1894
1898
|
};
|
|
1899
|
+
/**
|
|
1900
|
+
* Represents an outstanding vendor balance. This will contain either a payable bill
|
|
1901
|
+
* that requires payment, or an available credit that can be applied to a payment.
|
|
1902
|
+
*/
|
|
1903
|
+
export type BillPaymentOrCredit = {
|
|
1904
|
+
objectType?: string;
|
|
1905
|
+
createdAt: string;
|
|
1906
|
+
updatedAt: string;
|
|
1907
|
+
revisionNumber: string;
|
|
1908
|
+
bill?: PayableBill | null;
|
|
1909
|
+
credit?: ApplicableCredit | null;
|
|
1910
|
+
customFields?: Array<QbdDataExt>;
|
|
1911
|
+
};
|
|
1895
1912
|
/**
|
|
1896
1913
|
* A list object representing a billing rate, which is a custom price that overrides the standard price set for a service item, based on the entity (employee or vendor) that does the work [1, 2].
|
|
1897
1914
|
* This allows you to charge different rates based on who does the work or the difficulty of the task [1].
|
|
@@ -1966,19 +1983,6 @@ export type BillingRatePerItem = {
|
|
|
1966
1983
|
*/
|
|
1967
1984
|
customRatePercent?: number | null;
|
|
1968
1985
|
};
|
|
1969
|
-
/**
|
|
1970
|
-
* Represents an outstanding vendor balance. This will contain either a payable bill
|
|
1971
|
-
* that requires payment, or an available credit that can be applied to a payment.
|
|
1972
|
-
*/
|
|
1973
|
-
export type BillPaymentOrCredit = {
|
|
1974
|
-
objectType?: string;
|
|
1975
|
-
createdAt: string;
|
|
1976
|
-
updatedAt: string;
|
|
1977
|
-
revisionNumber: string;
|
|
1978
|
-
bill?: PayableBill | null;
|
|
1979
|
-
credit?: ApplicableCredit | null;
|
|
1980
|
-
customFields?: Array<QbdDataExt>;
|
|
1981
|
-
};
|
|
1982
1986
|
/**
|
|
1983
1987
|
* Data Transfer Object for BuildAssemblyRet.
|
|
1984
1988
|
*/
|
|
@@ -2590,30 +2594,6 @@ export type CreateAuthSessionRequest = {
|
|
|
2590
2594
|
*/
|
|
2591
2595
|
linkExpiryMins?: number | null;
|
|
2592
2596
|
};
|
|
2593
|
-
/**
|
|
2594
|
-
* Adds a billing rate to the billing rate list in QuickBooks Desktop.
|
|
2595
|
-
* Once created, it can be assigned to an employee or vendor to override service item rates in time transactions.
|
|
2596
|
-
* Use FixedBillingRate to override all items, or BillingRateItems to override specific ones.
|
|
2597
|
-
* Based on BillingRateAddRq.
|
|
2598
|
-
*/
|
|
2599
|
-
export type CreateBillingRateRequest = {
|
|
2600
|
-
/**
|
|
2601
|
-
* (Required) The name of the billing rate.
|
|
2602
|
-
*/
|
|
2603
|
-
name: string;
|
|
2604
|
-
/**
|
|
2605
|
-
* (Optional) Specifies a fixed billing rate that applies to all service items.
|
|
2606
|
-
* Mutually exclusive with BillingRateItems.
|
|
2607
|
-
*/
|
|
2608
|
-
fixedBillingRate?: number | null;
|
|
2609
|
-
/**
|
|
2610
|
-
* (Optional) Specific billing rates per service item.
|
|
2611
|
-
* If you want to specify more than one service item, use this list.
|
|
2612
|
-
* Mutually exclusive with FixedBillingRate.
|
|
2613
|
-
*/
|
|
2614
|
-
billingRateItems?: Array<BillingRateItemRequest> | null;
|
|
2615
|
-
externalId?: string | null;
|
|
2616
|
-
};
|
|
2617
2597
|
/**
|
|
2618
2598
|
* BillToPay is a read-only query result in QuickBooks and cannot be created directly.
|
|
2619
2599
|
*/
|
|
@@ -2679,6 +2659,30 @@ export type CreateBillRequest = {
|
|
|
2679
2659
|
*/
|
|
2680
2660
|
itemLines?: Array<CreateItemLineRequest> | null;
|
|
2681
2661
|
};
|
|
2662
|
+
/**
|
|
2663
|
+
* Adds a billing rate to the billing rate list in QuickBooks Desktop.
|
|
2664
|
+
* Once created, it can be assigned to an employee or vendor to override service item rates in time transactions.
|
|
2665
|
+
* Use FixedBillingRate to override all items, or BillingRateItems to override specific ones.
|
|
2666
|
+
* Based on BillingRateAddRq.
|
|
2667
|
+
*/
|
|
2668
|
+
export type CreateBillingRateRequest = {
|
|
2669
|
+
/**
|
|
2670
|
+
* (Required) The name of the billing rate.
|
|
2671
|
+
*/
|
|
2672
|
+
name: string;
|
|
2673
|
+
/**
|
|
2674
|
+
* (Optional) Specifies a fixed billing rate that applies to all service items.
|
|
2675
|
+
* Mutually exclusive with BillingRateItems.
|
|
2676
|
+
*/
|
|
2677
|
+
fixedBillingRate?: number | null;
|
|
2678
|
+
/**
|
|
2679
|
+
* (Optional) Specific billing rates per service item.
|
|
2680
|
+
* If you want to specify more than one service item, use this list.
|
|
2681
|
+
* Mutually exclusive with FixedBillingRate.
|
|
2682
|
+
*/
|
|
2683
|
+
billingRateItems?: Array<BillingRateItemRequest> | null;
|
|
2684
|
+
externalId?: string | null;
|
|
2685
|
+
};
|
|
2682
2686
|
/**
|
|
2683
2687
|
* A reusable request DTO for adding a Build Assembly transaction to QuickBooks.
|
|
2684
2688
|
* Adds a build assembly transaction where the specified quantity of the specified inventory assembly item is built.
|
|
@@ -7847,6 +7851,13 @@ export type JournalLine = {
|
|
|
7847
7851
|
*/
|
|
7848
7852
|
billableStatus?: string | null;
|
|
7849
7853
|
};
|
|
7854
|
+
export type LinkToTransactionLineRequest = {
|
|
7855
|
+
/**
|
|
7856
|
+
* (Required) The TxnID and TxnLineId of the transaction to link to.
|
|
7857
|
+
*/
|
|
7858
|
+
transactionId: string;
|
|
7859
|
+
transactionLineId: string;
|
|
7860
|
+
};
|
|
7850
7861
|
/**
|
|
7851
7862
|
* linked transactions that represent relationships between QuickBooks transactions.
|
|
7852
7863
|
*/
|
|
@@ -7868,13 +7879,6 @@ export type LinkedTransaction = {
|
|
|
7868
7879
|
*/
|
|
7869
7880
|
amount?: number;
|
|
7870
7881
|
};
|
|
7871
|
-
export type LinkToTransactionLineRequest = {
|
|
7872
|
-
/**
|
|
7873
|
-
* (Required) The TxnID and TxnLineId of the transaction to link to.
|
|
7874
|
-
*/
|
|
7875
|
-
transactionId: string;
|
|
7876
|
-
transactionLineId: string;
|
|
7877
|
-
};
|
|
7878
7882
|
/**
|
|
7879
7883
|
* Details for adjusting a lot-tracked item.
|
|
7880
7884
|
*/
|
|
@@ -8367,14 +8371,22 @@ export type QbdDataExt = {
|
|
|
8367
8371
|
value?: string | null;
|
|
8368
8372
|
};
|
|
8369
8373
|
/**
|
|
8370
|
-
*
|
|
8374
|
+
* A lightweight reference to another QuickBooks Desktop object.
|
|
8375
|
+
* <example>
|
|
8376
|
+
* ```{
|
|
8377
|
+
* "id": "123",
|
|
8378
|
+
* "fullname": "Acme Corp"
|
|
8379
|
+
* }```
|
|
8380
|
+
* </example>
|
|
8371
8381
|
*/
|
|
8372
8382
|
export type QbdRef = {
|
|
8373
8383
|
id: string;
|
|
8374
8384
|
/**
|
|
8375
|
-
* The fully-qualified name of the referenced object
|
|
8385
|
+
* The fully-qualified name of the referenced object, including any parent names separated by colons. Case-sensitive.
|
|
8386
|
+
*
|
|
8387
|
+
* Includes the entire parent hierarchy, with each level separated by colons, ending in the object's own name. For nested sub-items, it would be "Grandparent:Parent:Child"
|
|
8376
8388
|
*/
|
|
8377
|
-
|
|
8389
|
+
fullname?: string | null;
|
|
8378
8390
|
};
|
|
8379
8391
|
/**
|
|
8380
8392
|
* Details for a Quantity Adjustment (changes item quantity without changing cost).
|
|
@@ -23634,6 +23646,10 @@ export type ListCustomersData = {
|
|
|
23634
23646
|
* <example>["ListIDRet", "NameRet", "AddressRet", "PhoneRet"]</example>
|
|
23635
23647
|
*/
|
|
23636
23648
|
IncludeRetElementList?: Array<string>;
|
|
23649
|
+
/**
|
|
23650
|
+
* Optional: Filter by job status (customer-specific filter)
|
|
23651
|
+
*/
|
|
23652
|
+
JobStatus?: NullableJobStatus;
|
|
23637
23653
|
/**
|
|
23638
23654
|
* Filter by specific Class IDs.
|
|
23639
23655
|
*/
|
|
@@ -23647,10 +23663,6 @@ export type ListCustomersData = {
|
|
|
23647
23663
|
* Example: ?excludeShipToAddress=false
|
|
23648
23664
|
*/
|
|
23649
23665
|
excludeShipToAddress?: boolean;
|
|
23650
|
-
/**
|
|
23651
|
-
* Optional: Filter by job status (customer-specific filter)
|
|
23652
|
-
*/
|
|
23653
|
-
JobStatus?: NullableJobStatus;
|
|
23654
23666
|
/**
|
|
23655
23667
|
* Filter for customers whose totalBalance equals this amount.
|
|
23656
23668
|
* Mutually exclusive with other totalBalance filters.
|
|
@@ -33898,14 +33910,14 @@ export type ListInvoicesData = {
|
|
|
33898
33910
|
* to either a value of 0 (custom data) or the GUID for the private data.
|
|
33899
33911
|
*/
|
|
33900
33912
|
fields?: Array<string>;
|
|
33901
|
-
/**
|
|
33902
|
-
* Filter by Currency ListIDs (v8.0+).
|
|
33903
|
-
*/
|
|
33904
|
-
currencyIds?: Array<string>;
|
|
33905
33913
|
/**
|
|
33906
33914
|
* Filter by paid status (All, PaidOnly, NotPaidOnly) - invoice-specific filter
|
|
33907
33915
|
*/
|
|
33908
33916
|
PaidStatus?: NullablePaidStatus;
|
|
33917
|
+
/**
|
|
33918
|
+
* Filter by Currency ListIDs (v8.0+).
|
|
33919
|
+
*/
|
|
33920
|
+
currencyIds?: Array<string>;
|
|
33909
33921
|
};
|
|
33910
33922
|
url: "/api/v1/invoices";
|
|
33911
33923
|
};
|
|
@@ -34889,13 +34901,13 @@ export type RetrieveGeneralDetailReportData = {
|
|
|
34889
34901
|
};
|
|
34890
34902
|
path?: never;
|
|
34891
34903
|
query?: {
|
|
34892
|
-
AccountFullNames?: Array<string>;
|
|
34893
34904
|
AccountFullNameWithChildren?: string;
|
|
34905
|
+
AccountFullNames?: Array<string>;
|
|
34906
|
+
AccountIdWithChildren?: string;
|
|
34894
34907
|
/**
|
|
34895
34908
|
* Filter by Account IDs
|
|
34896
34909
|
*/
|
|
34897
34910
|
AccountIds?: Array<string>;
|
|
34898
|
-
AccountIdWithChildren?: string;
|
|
34899
34911
|
AccountType?: string;
|
|
34900
34912
|
/**
|
|
34901
34913
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -34905,13 +34917,13 @@ export type RetrieveGeneralDetailReportData = {
|
|
|
34905
34917
|
AgingAsOf?: string;
|
|
34906
34918
|
Calendar?: string;
|
|
34907
34919
|
ClassFullNames?: Array<string>;
|
|
34920
|
+
ClassIdWithChildren?: string;
|
|
34908
34921
|
/**
|
|
34909
34922
|
* Filter by Class IDs
|
|
34910
34923
|
*
|
|
34911
34924
|
* Provide a list of strictly matched ClassIDs.
|
|
34912
34925
|
*/
|
|
34913
34926
|
ClassIds?: Array<string>;
|
|
34914
|
-
ClassIdWithChildren?: string;
|
|
34915
34927
|
ClassNameWithChildren?: string;
|
|
34916
34928
|
/**
|
|
34917
34929
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -34933,13 +34945,13 @@ export type RetrieveGeneralDetailReportData = {
|
|
|
34933
34945
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
34934
34946
|
*/
|
|
34935
34947
|
DisplayReport?: boolean | null;
|
|
34936
|
-
EntityFullNames?: Array<string>;
|
|
34937
34948
|
EntityFullNameWithChildren?: string;
|
|
34949
|
+
EntityFullNames?: Array<string>;
|
|
34950
|
+
EntityIdWithChildren?: string;
|
|
34938
34951
|
/**
|
|
34939
34952
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
34940
34953
|
*/
|
|
34941
34954
|
EntityIds?: Array<string>;
|
|
34942
|
-
EntityIdWithChildren?: string;
|
|
34943
34955
|
EntityType?: string;
|
|
34944
34956
|
/**
|
|
34945
34957
|
* Filter for records modified on or after this date.
|
|
@@ -34972,11 +34984,11 @@ export type RetrieveGeneralDetailReportData = {
|
|
|
34972
34984
|
IncludeColumnList?: Array<string>;
|
|
34973
34985
|
IncludeSubcolumns?: boolean | null;
|
|
34974
34986
|
ItemFullNames?: Array<string>;
|
|
34987
|
+
ItemIdWithChildren?: string;
|
|
34975
34988
|
/**
|
|
34976
34989
|
* Filter by Item IDs
|
|
34977
34990
|
*/
|
|
34978
34991
|
ItemIds?: Array<string>;
|
|
34979
|
-
ItemIdWithChildren?: string;
|
|
34980
34992
|
ItemNameWithChildren?: string;
|
|
34981
34993
|
ItemType?: string;
|
|
34982
34994
|
/**
|
|
@@ -35097,13 +35109,13 @@ export type RetrieveAgingReportData = {
|
|
|
35097
35109
|
};
|
|
35098
35110
|
path?: never;
|
|
35099
35111
|
query?: {
|
|
35100
|
-
AccountFullNames?: Array<string>;
|
|
35101
35112
|
AccountFullNameWithChildren?: string;
|
|
35113
|
+
AccountFullNames?: Array<string>;
|
|
35114
|
+
AccountIdWithChildren?: string;
|
|
35102
35115
|
/**
|
|
35103
35116
|
* Filter by Account IDs
|
|
35104
35117
|
*/
|
|
35105
35118
|
AccountIds?: Array<string>;
|
|
35106
|
-
AccountIdWithChildren?: string;
|
|
35107
35119
|
AccountType?: string;
|
|
35108
35120
|
/**
|
|
35109
35121
|
* The date from which aging is calculated. Valid values: ReportEndDate (default), Today
|
|
@@ -35116,13 +35128,13 @@ export type RetrieveAgingReportData = {
|
|
|
35116
35128
|
AgingType?: string;
|
|
35117
35129
|
Calendar?: string;
|
|
35118
35130
|
ClassFullNames?: Array<string>;
|
|
35131
|
+
ClassIdWithChildren?: string;
|
|
35119
35132
|
/**
|
|
35120
35133
|
* Filter by Class IDs
|
|
35121
35134
|
*
|
|
35122
35135
|
* Provide a list of strictly matched ClassIDs.
|
|
35123
35136
|
*/
|
|
35124
35137
|
ClassIds?: Array<string>;
|
|
35125
|
-
ClassIdWithChildren?: string;
|
|
35126
35138
|
ClassNameWithChildren?: string;
|
|
35127
35139
|
/**
|
|
35128
35140
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -35144,13 +35156,13 @@ export type RetrieveAgingReportData = {
|
|
|
35144
35156
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
35145
35157
|
*/
|
|
35146
35158
|
DisplayReport?: boolean | null;
|
|
35147
|
-
EntityFullNames?: Array<string>;
|
|
35148
35159
|
EntityFullNameWithChildren?: string;
|
|
35160
|
+
EntityFullNames?: Array<string>;
|
|
35161
|
+
EntityIdWithChildren?: string;
|
|
35149
35162
|
/**
|
|
35150
35163
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
35151
35164
|
*/
|
|
35152
35165
|
EntityIds?: Array<string>;
|
|
35153
|
-
EntityIdWithChildren?: string;
|
|
35154
35166
|
EntityType?: string;
|
|
35155
35167
|
/**
|
|
35156
35168
|
* Filter for records modified on or after this date.
|
|
@@ -35169,11 +35181,11 @@ export type RetrieveAgingReportData = {
|
|
|
35169
35181
|
IncludeColumnList?: Array<string>;
|
|
35170
35182
|
IncludeSubcolumns?: boolean | null;
|
|
35171
35183
|
ItemFullNames?: Array<string>;
|
|
35184
|
+
ItemIdWithChildren?: string;
|
|
35172
35185
|
/**
|
|
35173
35186
|
* Filter by Item IDs
|
|
35174
35187
|
*/
|
|
35175
35188
|
ItemIds?: Array<string>;
|
|
35176
|
-
ItemIdWithChildren?: string;
|
|
35177
35189
|
ItemNameWithChildren?: string;
|
|
35178
35190
|
ItemType?: string;
|
|
35179
35191
|
/**
|
|
@@ -35294,13 +35306,13 @@ export type RetrieveGeneralSummaryReportData = {
|
|
|
35294
35306
|
};
|
|
35295
35307
|
path?: never;
|
|
35296
35308
|
query?: {
|
|
35297
|
-
AccountFullNames?: Array<string>;
|
|
35298
35309
|
AccountFullNameWithChildren?: string;
|
|
35310
|
+
AccountFullNames?: Array<string>;
|
|
35311
|
+
AccountIdWithChildren?: string;
|
|
35299
35312
|
/**
|
|
35300
35313
|
* Filter by Account IDs
|
|
35301
35314
|
*/
|
|
35302
35315
|
AccountIds?: Array<string>;
|
|
35303
|
-
AccountIdWithChildren?: string;
|
|
35304
35316
|
AccountType?: string;
|
|
35305
35317
|
/**
|
|
35306
35318
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -35310,13 +35322,13 @@ export type RetrieveGeneralSummaryReportData = {
|
|
|
35310
35322
|
AgingAsOf?: string;
|
|
35311
35323
|
Calendar?: string;
|
|
35312
35324
|
ClassFullNames?: Array<string>;
|
|
35325
|
+
ClassIdWithChildren?: string;
|
|
35313
35326
|
/**
|
|
35314
35327
|
* Filter by Class IDs
|
|
35315
35328
|
*
|
|
35316
35329
|
* Provide a list of strictly matched ClassIDs.
|
|
35317
35330
|
*/
|
|
35318
35331
|
ClassIds?: Array<string>;
|
|
35319
|
-
ClassIdWithChildren?: string;
|
|
35320
35332
|
ClassNameWithChildren?: string;
|
|
35321
35333
|
/**
|
|
35322
35334
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -35338,13 +35350,13 @@ export type RetrieveGeneralSummaryReportData = {
|
|
|
35338
35350
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
35339
35351
|
*/
|
|
35340
35352
|
DisplayReport?: boolean | null;
|
|
35341
|
-
EntityFullNames?: Array<string>;
|
|
35342
35353
|
EntityFullNameWithChildren?: string;
|
|
35354
|
+
EntityFullNames?: Array<string>;
|
|
35355
|
+
EntityIdWithChildren?: string;
|
|
35343
35356
|
/**
|
|
35344
35357
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
35345
35358
|
*/
|
|
35346
35359
|
EntityIds?: Array<string>;
|
|
35347
|
-
EntityIdWithChildren?: string;
|
|
35348
35360
|
EntityType?: string;
|
|
35349
35361
|
/**
|
|
35350
35362
|
* Filter for records modified on or after this date.
|
|
@@ -35378,11 +35390,11 @@ export type RetrieveGeneralSummaryReportData = {
|
|
|
35378
35390
|
IncludeColumnList?: Array<string>;
|
|
35379
35391
|
IncludeSubcolumns?: boolean | null;
|
|
35380
35392
|
ItemFullNames?: Array<string>;
|
|
35393
|
+
ItemIdWithChildren?: string;
|
|
35381
35394
|
/**
|
|
35382
35395
|
* Filter by Item IDs
|
|
35383
35396
|
*/
|
|
35384
35397
|
ItemIds?: Array<string>;
|
|
35385
|
-
ItemIdWithChildren?: string;
|
|
35386
35398
|
ItemNameWithChildren?: string;
|
|
35387
35399
|
ItemType?: string;
|
|
35388
35400
|
/**
|
|
@@ -35503,13 +35515,13 @@ export type RetrieveBudgetSummaryReportData = {
|
|
|
35503
35515
|
};
|
|
35504
35516
|
path?: never;
|
|
35505
35517
|
query?: {
|
|
35506
|
-
AccountFullNames?: Array<string>;
|
|
35507
35518
|
AccountFullNameWithChildren?: string;
|
|
35519
|
+
AccountFullNames?: Array<string>;
|
|
35520
|
+
AccountIdWithChildren?: string;
|
|
35508
35521
|
/**
|
|
35509
35522
|
* Filter by Account IDs
|
|
35510
35523
|
*/
|
|
35511
35524
|
AccountIds?: Array<string>;
|
|
35512
|
-
AccountIdWithChildren?: string;
|
|
35513
35525
|
AccountType?: string;
|
|
35514
35526
|
/**
|
|
35515
35527
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -35528,13 +35540,13 @@ export type RetrieveBudgetSummaryReportData = {
|
|
|
35528
35540
|
BudgetType?: string;
|
|
35529
35541
|
Calendar?: string;
|
|
35530
35542
|
ClassFullNames?: Array<string>;
|
|
35543
|
+
ClassIdWithChildren?: string;
|
|
35531
35544
|
/**
|
|
35532
35545
|
* Filter by Class IDs
|
|
35533
35546
|
*
|
|
35534
35547
|
* Provide a list of strictly matched ClassIDs.
|
|
35535
35548
|
*/
|
|
35536
35549
|
ClassIds?: Array<string>;
|
|
35537
|
-
ClassIdWithChildren?: string;
|
|
35538
35550
|
ClassNameWithChildren?: string;
|
|
35539
35551
|
/**
|
|
35540
35552
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -35556,13 +35568,13 @@ export type RetrieveBudgetSummaryReportData = {
|
|
|
35556
35568
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
35557
35569
|
*/
|
|
35558
35570
|
DisplayReport?: boolean | null;
|
|
35559
|
-
EntityFullNames?: Array<string>;
|
|
35560
35571
|
EntityFullNameWithChildren?: string;
|
|
35572
|
+
EntityFullNames?: Array<string>;
|
|
35573
|
+
EntityIdWithChildren?: string;
|
|
35561
35574
|
/**
|
|
35562
35575
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
35563
35576
|
*/
|
|
35564
35577
|
EntityIds?: Array<string>;
|
|
35565
|
-
EntityIdWithChildren?: string;
|
|
35566
35578
|
EntityType?: string;
|
|
35567
35579
|
/**
|
|
35568
35580
|
* The fiscal year for the budget report (4-digit, e.g. 2024).
|
|
@@ -35587,11 +35599,11 @@ export type RetrieveBudgetSummaryReportData = {
|
|
|
35587
35599
|
IncludeColumnList?: Array<string>;
|
|
35588
35600
|
IncludeSubcolumns?: boolean | null;
|
|
35589
35601
|
ItemFullNames?: Array<string>;
|
|
35602
|
+
ItemIdWithChildren?: string;
|
|
35590
35603
|
/**
|
|
35591
35604
|
* Filter by Item IDs
|
|
35592
35605
|
*/
|
|
35593
35606
|
ItemIds?: Array<string>;
|
|
35594
|
-
ItemIdWithChildren?: string;
|
|
35595
35607
|
ItemNameWithChildren?: string;
|
|
35596
35608
|
ItemType?: string;
|
|
35597
35609
|
/**
|
|
@@ -35720,13 +35732,13 @@ export type RetrieveJobReportData = {
|
|
|
35720
35732
|
};
|
|
35721
35733
|
path?: never;
|
|
35722
35734
|
query?: {
|
|
35723
|
-
AccountFullNames?: Array<string>;
|
|
35724
35735
|
AccountFullNameWithChildren?: string;
|
|
35736
|
+
AccountFullNames?: Array<string>;
|
|
35737
|
+
AccountIdWithChildren?: string;
|
|
35725
35738
|
/**
|
|
35726
35739
|
* Filter by Account IDs
|
|
35727
35740
|
*/
|
|
35728
35741
|
AccountIds?: Array<string>;
|
|
35729
|
-
AccountIdWithChildren?: string;
|
|
35730
35742
|
AccountType?: string;
|
|
35731
35743
|
/**
|
|
35732
35744
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -35736,13 +35748,13 @@ export type RetrieveJobReportData = {
|
|
|
35736
35748
|
AgingAsOf?: string;
|
|
35737
35749
|
Calendar?: string;
|
|
35738
35750
|
ClassFullNames?: Array<string>;
|
|
35751
|
+
ClassIdWithChildren?: string;
|
|
35739
35752
|
/**
|
|
35740
35753
|
* Filter by Class IDs
|
|
35741
35754
|
*
|
|
35742
35755
|
* Provide a list of strictly matched ClassIDs.
|
|
35743
35756
|
*/
|
|
35744
35757
|
ClassIds?: Array<string>;
|
|
35745
|
-
ClassIdWithChildren?: string;
|
|
35746
35758
|
ClassNameWithChildren?: string;
|
|
35747
35759
|
/**
|
|
35748
35760
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -35764,13 +35776,13 @@ export type RetrieveJobReportData = {
|
|
|
35764
35776
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
35765
35777
|
*/
|
|
35766
35778
|
DisplayReport?: boolean | null;
|
|
35767
|
-
EntityFullNames?: Array<string>;
|
|
35768
35779
|
EntityFullNameWithChildren?: string;
|
|
35780
|
+
EntityFullNames?: Array<string>;
|
|
35781
|
+
EntityIdWithChildren?: string;
|
|
35769
35782
|
/**
|
|
35770
35783
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
35771
35784
|
*/
|
|
35772
35785
|
EntityIds?: Array<string>;
|
|
35773
|
-
EntityIdWithChildren?: string;
|
|
35774
35786
|
EntityType?: string;
|
|
35775
35787
|
/**
|
|
35776
35788
|
* Filter for records modified on or after this date.
|
|
@@ -35791,11 +35803,11 @@ export type RetrieveJobReportData = {
|
|
|
35791
35803
|
IncludeColumnList?: Array<string>;
|
|
35792
35804
|
IncludeSubcolumns?: boolean | null;
|
|
35793
35805
|
ItemFullNames?: Array<string>;
|
|
35806
|
+
ItemIdWithChildren?: string;
|
|
35794
35807
|
/**
|
|
35795
35808
|
* Filter by Item IDs
|
|
35796
35809
|
*/
|
|
35797
35810
|
ItemIds?: Array<string>;
|
|
35798
|
-
ItemIdWithChildren?: string;
|
|
35799
35811
|
ItemNameWithChildren?: string;
|
|
35800
35812
|
ItemType?: string;
|
|
35801
35813
|
/**
|
|
@@ -35922,13 +35934,13 @@ export type RetrieveTimeReportData = {
|
|
|
35922
35934
|
};
|
|
35923
35935
|
path?: never;
|
|
35924
35936
|
query?: {
|
|
35925
|
-
AccountFullNames?: Array<string>;
|
|
35926
35937
|
AccountFullNameWithChildren?: string;
|
|
35938
|
+
AccountFullNames?: Array<string>;
|
|
35939
|
+
AccountIdWithChildren?: string;
|
|
35927
35940
|
/**
|
|
35928
35941
|
* Filter by Account IDs
|
|
35929
35942
|
*/
|
|
35930
35943
|
AccountIds?: Array<string>;
|
|
35931
|
-
AccountIdWithChildren?: string;
|
|
35932
35944
|
AccountType?: string;
|
|
35933
35945
|
/**
|
|
35934
35946
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -35938,13 +35950,13 @@ export type RetrieveTimeReportData = {
|
|
|
35938
35950
|
AgingAsOf?: string;
|
|
35939
35951
|
Calendar?: string;
|
|
35940
35952
|
ClassFullNames?: Array<string>;
|
|
35953
|
+
ClassIdWithChildren?: string;
|
|
35941
35954
|
/**
|
|
35942
35955
|
* Filter by Class IDs
|
|
35943
35956
|
*
|
|
35944
35957
|
* Provide a list of strictly matched ClassIDs.
|
|
35945
35958
|
*/
|
|
35946
35959
|
ClassIds?: Array<string>;
|
|
35947
|
-
ClassIdWithChildren?: string;
|
|
35948
35960
|
ClassNameWithChildren?: string;
|
|
35949
35961
|
/**
|
|
35950
35962
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -35966,13 +35978,13 @@ export type RetrieveTimeReportData = {
|
|
|
35966
35978
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
35967
35979
|
*/
|
|
35968
35980
|
DisplayReport?: boolean | null;
|
|
35969
|
-
EntityFullNames?: Array<string>;
|
|
35970
35981
|
EntityFullNameWithChildren?: string;
|
|
35982
|
+
EntityFullNames?: Array<string>;
|
|
35983
|
+
EntityIdWithChildren?: string;
|
|
35971
35984
|
/**
|
|
35972
35985
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
35973
35986
|
*/
|
|
35974
35987
|
EntityIds?: Array<string>;
|
|
35975
|
-
EntityIdWithChildren?: string;
|
|
35976
35988
|
EntityType?: string;
|
|
35977
35989
|
/**
|
|
35978
35990
|
* Filter for records modified on or after this date.
|
|
@@ -35993,11 +36005,11 @@ export type RetrieveTimeReportData = {
|
|
|
35993
36005
|
IncludeColumnList?: Array<string>;
|
|
35994
36006
|
IncludeSubcolumns?: boolean | null;
|
|
35995
36007
|
ItemFullNames?: Array<string>;
|
|
36008
|
+
ItemIdWithChildren?: string;
|
|
35996
36009
|
/**
|
|
35997
36010
|
* Filter by Item IDs
|
|
35998
36011
|
*/
|
|
35999
36012
|
ItemIds?: Array<string>;
|
|
36000
|
-
ItemIdWithChildren?: string;
|
|
36001
36013
|
ItemNameWithChildren?: string;
|
|
36002
36014
|
ItemType?: string;
|
|
36003
36015
|
/**
|
|
@@ -36122,13 +36134,13 @@ export type RetrieveCustomDetailReportData = {
|
|
|
36122
36134
|
};
|
|
36123
36135
|
path?: never;
|
|
36124
36136
|
query?: {
|
|
36125
|
-
AccountFullNames?: Array<string>;
|
|
36126
36137
|
AccountFullNameWithChildren?: string;
|
|
36138
|
+
AccountFullNames?: Array<string>;
|
|
36139
|
+
AccountIdWithChildren?: string;
|
|
36127
36140
|
/**
|
|
36128
36141
|
* Filter by Account IDs
|
|
36129
36142
|
*/
|
|
36130
36143
|
AccountIds?: Array<string>;
|
|
36131
|
-
AccountIdWithChildren?: string;
|
|
36132
36144
|
AccountType?: string;
|
|
36133
36145
|
/**
|
|
36134
36146
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -36138,13 +36150,13 @@ export type RetrieveCustomDetailReportData = {
|
|
|
36138
36150
|
AgingAsOf?: string;
|
|
36139
36151
|
Calendar?: string;
|
|
36140
36152
|
ClassFullNames?: Array<string>;
|
|
36153
|
+
ClassIdWithChildren?: string;
|
|
36141
36154
|
/**
|
|
36142
36155
|
* Filter by Class IDs
|
|
36143
36156
|
*
|
|
36144
36157
|
* Provide a list of strictly matched ClassIDs.
|
|
36145
36158
|
*/
|
|
36146
36159
|
ClassIds?: Array<string>;
|
|
36147
|
-
ClassIdWithChildren?: string;
|
|
36148
36160
|
ClassNameWithChildren?: string;
|
|
36149
36161
|
/**
|
|
36150
36162
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -36170,13 +36182,13 @@ export type RetrieveCustomDetailReportData = {
|
|
|
36170
36182
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
36171
36183
|
*/
|
|
36172
36184
|
DisplayReport?: boolean | null;
|
|
36173
|
-
EntityFullNames?: Array<string>;
|
|
36174
36185
|
EntityFullNameWithChildren?: string;
|
|
36186
|
+
EntityFullNames?: Array<string>;
|
|
36187
|
+
EntityIdWithChildren?: string;
|
|
36175
36188
|
/**
|
|
36176
36189
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
36177
36190
|
*/
|
|
36178
36191
|
EntityIds?: Array<string>;
|
|
36179
|
-
EntityIdWithChildren?: string;
|
|
36180
36192
|
EntityType?: string;
|
|
36181
36193
|
/**
|
|
36182
36194
|
* Filter for records modified on or after this date.
|
|
@@ -36197,11 +36209,11 @@ export type RetrieveCustomDetailReportData = {
|
|
|
36197
36209
|
IncludeColumnList?: Array<string>;
|
|
36198
36210
|
IncludeSubcolumns?: boolean | null;
|
|
36199
36211
|
ItemFullNames?: Array<string>;
|
|
36212
|
+
ItemIdWithChildren?: string;
|
|
36200
36213
|
/**
|
|
36201
36214
|
* Filter by Item IDs
|
|
36202
36215
|
*/
|
|
36203
36216
|
ItemIds?: Array<string>;
|
|
36204
|
-
ItemIdWithChildren?: string;
|
|
36205
36217
|
ItemNameWithChildren?: string;
|
|
36206
36218
|
ItemType?: string;
|
|
36207
36219
|
/**
|
|
@@ -36322,13 +36334,13 @@ export type RetrieveCustomSummaryReportData = {
|
|
|
36322
36334
|
};
|
|
36323
36335
|
path?: never;
|
|
36324
36336
|
query?: {
|
|
36325
|
-
AccountFullNames?: Array<string>;
|
|
36326
36337
|
AccountFullNameWithChildren?: string;
|
|
36338
|
+
AccountFullNames?: Array<string>;
|
|
36339
|
+
AccountIdWithChildren?: string;
|
|
36327
36340
|
/**
|
|
36328
36341
|
* Filter by Account IDs
|
|
36329
36342
|
*/
|
|
36330
36343
|
AccountIds?: Array<string>;
|
|
36331
|
-
AccountIdWithChildren?: string;
|
|
36332
36344
|
AccountType?: string;
|
|
36333
36345
|
/**
|
|
36334
36346
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -36338,13 +36350,13 @@ export type RetrieveCustomSummaryReportData = {
|
|
|
36338
36350
|
AgingAsOf?: string;
|
|
36339
36351
|
Calendar?: string;
|
|
36340
36352
|
ClassFullNames?: Array<string>;
|
|
36353
|
+
ClassIdWithChildren?: string;
|
|
36341
36354
|
/**
|
|
36342
36355
|
* Filter by Class IDs
|
|
36343
36356
|
*
|
|
36344
36357
|
* Provide a list of strictly matched ClassIDs.
|
|
36345
36358
|
*/
|
|
36346
36359
|
ClassIds?: Array<string>;
|
|
36347
|
-
ClassIdWithChildren?: string;
|
|
36348
36360
|
ClassNameWithChildren?: string;
|
|
36349
36361
|
/**
|
|
36350
36362
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -36370,13 +36382,13 @@ export type RetrieveCustomSummaryReportData = {
|
|
|
36370
36382
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
36371
36383
|
*/
|
|
36372
36384
|
DisplayReport?: boolean | null;
|
|
36373
|
-
EntityFullNames?: Array<string>;
|
|
36374
36385
|
EntityFullNameWithChildren?: string;
|
|
36386
|
+
EntityFullNames?: Array<string>;
|
|
36387
|
+
EntityIdWithChildren?: string;
|
|
36375
36388
|
/**
|
|
36376
36389
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
36377
36390
|
*/
|
|
36378
36391
|
EntityIds?: Array<string>;
|
|
36379
|
-
EntityIdWithChildren?: string;
|
|
36380
36392
|
EntityType?: string;
|
|
36381
36393
|
/**
|
|
36382
36394
|
* Filter for records modified on or after this date.
|
|
@@ -36397,11 +36409,11 @@ export type RetrieveCustomSummaryReportData = {
|
|
|
36397
36409
|
IncludeColumnList?: Array<string>;
|
|
36398
36410
|
IncludeSubcolumns?: boolean | null;
|
|
36399
36411
|
ItemFullNames?: Array<string>;
|
|
36412
|
+
ItemIdWithChildren?: string;
|
|
36400
36413
|
/**
|
|
36401
36414
|
* Filter by Item IDs
|
|
36402
36415
|
*/
|
|
36403
36416
|
ItemIds?: Array<string>;
|
|
36404
|
-
ItemIdWithChildren?: string;
|
|
36405
36417
|
ItemNameWithChildren?: string;
|
|
36406
36418
|
ItemType?: string;
|
|
36407
36419
|
/**
|
|
@@ -36522,13 +36534,13 @@ export type RetrievePayrollDetailReportData = {
|
|
|
36522
36534
|
};
|
|
36523
36535
|
path?: never;
|
|
36524
36536
|
query?: {
|
|
36525
|
-
AccountFullNames?: Array<string>;
|
|
36526
36537
|
AccountFullNameWithChildren?: string;
|
|
36538
|
+
AccountFullNames?: Array<string>;
|
|
36539
|
+
AccountIdWithChildren?: string;
|
|
36527
36540
|
/**
|
|
36528
36541
|
* Filter by Account IDs
|
|
36529
36542
|
*/
|
|
36530
36543
|
AccountIds?: Array<string>;
|
|
36531
|
-
AccountIdWithChildren?: string;
|
|
36532
36544
|
AccountType?: string;
|
|
36533
36545
|
/**
|
|
36534
36546
|
* The date from which to calculate aging in an Aging report.
|
|
@@ -36538,13 +36550,13 @@ export type RetrievePayrollDetailReportData = {
|
|
|
36538
36550
|
AgingAsOf?: string;
|
|
36539
36551
|
Calendar?: string;
|
|
36540
36552
|
ClassFullNames?: Array<string>;
|
|
36553
|
+
ClassIdWithChildren?: string;
|
|
36541
36554
|
/**
|
|
36542
36555
|
* Filter by Class IDs
|
|
36543
36556
|
*
|
|
36544
36557
|
* Provide a list of strictly matched ClassIDs.
|
|
36545
36558
|
*/
|
|
36546
36559
|
ClassIds?: Array<string>;
|
|
36547
|
-
ClassIdWithChildren?: string;
|
|
36548
36560
|
ClassNameWithChildren?: string;
|
|
36549
36561
|
/**
|
|
36550
36562
|
* The pagination cursor token used to retrieve the next set of records.
|
|
@@ -36566,13 +36578,13 @@ export type RetrievePayrollDetailReportData = {
|
|
|
36566
36578
|
* If false or null, the report is only returned via QBXML without displaying.
|
|
36567
36579
|
*/
|
|
36568
36580
|
DisplayReport?: boolean | null;
|
|
36569
|
-
EntityFullNames?: Array<string>;
|
|
36570
36581
|
EntityFullNameWithChildren?: string;
|
|
36582
|
+
EntityFullNames?: Array<string>;
|
|
36583
|
+
EntityIdWithChildren?: string;
|
|
36571
36584
|
/**
|
|
36572
36585
|
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
36573
36586
|
*/
|
|
36574
36587
|
EntityIds?: Array<string>;
|
|
36575
|
-
EntityIdWithChildren?: string;
|
|
36576
36588
|
EntityType?: string;
|
|
36577
36589
|
/**
|
|
36578
36590
|
* Filter for records modified on or after this date.
|
|
@@ -36593,11 +36605,11 @@ export type RetrievePayrollDetailReportData = {
|
|
|
36593
36605
|
IncludeColumnList?: Array<string>;
|
|
36594
36606
|
IncludeSubcolumns?: boolean | null;
|
|
36595
36607
|
ItemFullNames?: Array<string>;
|
|
36608
|
+
ItemIdWithChildren?: string;
|
|
36596
36609
|
/**
|
|
36597
36610
|
* Filter by Item IDs
|
|
36598
36611
|
*/
|
|
36599
36612
|
ItemIds?: Array<string>;
|
|
36600
|
-
ItemIdWithChildren?: string;
|
|
36601
36613
|
ItemNameWithChildren?: string;
|
|
36602
36614
|
ItemType?: string;
|
|
36603
36615
|
/**
|