conductor-node 14.13.0 → 14.15.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 +16 -0
- package/package.json +1 -1
- package/resources/qbd/reports.d.mts +608 -526
- package/resources/qbd/reports.d.mts.map +1 -1
- package/resources/qbd/reports.d.ts +608 -526
- package/resources/qbd/reports.d.ts.map +1 -1
- package/resources/qbd/reports.js +45 -10
- package/resources/qbd/reports.js.map +1 -1
- package/resources/qbd/reports.mjs +45 -10
- package/resources/qbd/reports.mjs.map +1 -1
- package/src/resources/qbd/reports.ts +608 -526
- 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
|
@@ -7,7 +7,10 @@ import { RequestOptions } from '../../internal/request-options';
|
|
|
7
7
|
|
|
8
8
|
export class Reports extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Retrieves an aging report
|
|
10
|
+
* Retrieves an accounts receivable, accounts payable, or collections aging report
|
|
11
|
+
* showing unpaid invoices and bills by aging criteria. This report is useful for
|
|
12
|
+
* analyzing receivables, payables, and collection work across summary or detail
|
|
13
|
+
* aging views.
|
|
11
14
|
*
|
|
12
15
|
* @example
|
|
13
16
|
* ```ts
|
|
@@ -27,7 +30,11 @@ export class Reports extends APIResource {
|
|
|
27
30
|
}
|
|
28
31
|
|
|
29
32
|
/**
|
|
30
|
-
* Retrieves a budget summary report
|
|
33
|
+
* Retrieves a QuickBooks Desktop budget summary report for Balance Sheet or Profit
|
|
34
|
+
* and Loss budgets, including budget overview, budget versus actual, and
|
|
35
|
+
* performance views. This report compares budgeted amounts against actual activity
|
|
36
|
+
* for a fiscal year and budget criterion; the target budget must already exist in
|
|
37
|
+
* QuickBooks Desktop.
|
|
31
38
|
*
|
|
32
39
|
* @example
|
|
33
40
|
* ```ts
|
|
@@ -48,7 +55,10 @@ export class Reports extends APIResource {
|
|
|
48
55
|
}
|
|
49
56
|
|
|
50
57
|
/**
|
|
51
|
-
* Retrieves a custom detail report
|
|
58
|
+
* Retrieves a custom transaction detail report built from the row grouping,
|
|
59
|
+
* included columns, date period, and filters you request. This report is useful
|
|
60
|
+
* when no preset detail report exposes the transaction rows or report-only columns
|
|
61
|
+
* you need; QuickBooks Desktop does not choose default columns for this report.
|
|
52
62
|
*
|
|
53
63
|
* @example
|
|
54
64
|
* ```ts
|
|
@@ -69,7 +79,10 @@ export class Reports extends APIResource {
|
|
|
69
79
|
}
|
|
70
80
|
|
|
71
81
|
/**
|
|
72
|
-
* Retrieves a custom summary report
|
|
82
|
+
* Retrieves a custom summary report built from the row and column axes, filters,
|
|
83
|
+
* date period, calendar, and basis options you request. This report is useful when
|
|
84
|
+
* preset summary reports do not match the dimensions you need; QuickBooks Desktop
|
|
85
|
+
* does not assume a default layout.
|
|
73
86
|
*
|
|
74
87
|
* @example
|
|
75
88
|
* ```ts
|
|
@@ -90,7 +103,12 @@ export class Reports extends APIResource {
|
|
|
90
103
|
}
|
|
91
104
|
|
|
92
105
|
/**
|
|
93
|
-
* Retrieves a general detail report
|
|
106
|
+
* Retrieves a QuickBooks Desktop general detail report with transaction-level
|
|
107
|
+
* rows, such as General Ledger, Journal, Open Invoices, unpaid bills, sales
|
|
108
|
+
* detail, purchase detail, audit trail, and transaction lists. This report is
|
|
109
|
+
* useful for inspecting the transactions behind balances, receivables, payables,
|
|
110
|
+
* sales, purchases, inventory valuation, and audit activity, including report-only
|
|
111
|
+
* columns that may not be available from standard object queries.
|
|
94
112
|
*
|
|
95
113
|
* @example
|
|
96
114
|
* ```ts
|
|
@@ -110,7 +128,11 @@ export class Reports extends APIResource {
|
|
|
110
128
|
}
|
|
111
129
|
|
|
112
130
|
/**
|
|
113
|
-
* Retrieves a general summary report
|
|
131
|
+
* Retrieves a QuickBooks Desktop general summary report, such as a balance sheet,
|
|
132
|
+
* profit and loss, trial balance, sales, purchase, inventory, customer balance,
|
|
133
|
+
* vendor balance, sales tax, or income tax summary. This report is useful for
|
|
134
|
+
* aggregated financial or operational totals with optional date periods, filters,
|
|
135
|
+
* calendar settings, and column summarization.
|
|
114
136
|
*
|
|
115
137
|
* @example
|
|
116
138
|
* ```ts
|
|
@@ -130,7 +152,11 @@ export class Reports extends APIResource {
|
|
|
130
152
|
}
|
|
131
153
|
|
|
132
154
|
/**
|
|
133
|
-
* Retrieves a job report
|
|
155
|
+
* Retrieves a QuickBooks Desktop job report for estimates versus actuals, item
|
|
156
|
+
* profitability, or job profitability. This report is useful for project costing,
|
|
157
|
+
* margin analysis, and estimate tracking by customer or job; job profitability
|
|
158
|
+
* detail and estimates-versus-actuals detail report types require a customer or
|
|
159
|
+
* job filter.
|
|
134
160
|
*
|
|
135
161
|
* @example
|
|
136
162
|
* ```ts
|
|
@@ -150,7 +176,11 @@ export class Reports extends APIResource {
|
|
|
150
176
|
}
|
|
151
177
|
|
|
152
178
|
/**
|
|
153
|
-
* Retrieves a payroll detail report
|
|
179
|
+
* Retrieves a QuickBooks Desktop payroll detail report, including employee state
|
|
180
|
+
* tax detail, payroll item detail, payroll review detail, payroll transaction
|
|
181
|
+
* detail, and payroll transactions by payee. This report is useful for auditing
|
|
182
|
+
* paycheck line items, payroll item usage, tax calculations, and payee-level
|
|
183
|
+
* payroll activity.
|
|
154
184
|
*
|
|
155
185
|
* @example
|
|
156
186
|
* ```ts
|
|
@@ -170,7 +200,10 @@ export class Reports extends APIResource {
|
|
|
170
200
|
}
|
|
171
201
|
|
|
172
202
|
/**
|
|
173
|
-
* Retrieves a payroll summary report
|
|
203
|
+
* Retrieves a QuickBooks Desktop payroll summary report, including payroll totals
|
|
204
|
+
* by employee, employee earnings by payroll item, and payroll liability balances.
|
|
205
|
+
* This report is useful for wage, tax, deduction, addition, employer contribution,
|
|
206
|
+
* and unpaid payroll liability reporting.
|
|
174
207
|
*
|
|
175
208
|
* @example
|
|
176
209
|
* ```ts
|
|
@@ -190,7 +223,9 @@ export class Reports extends APIResource {
|
|
|
190
223
|
}
|
|
191
224
|
|
|
192
225
|
/**
|
|
193
|
-
* Retrieves a time report
|
|
226
|
+
* Retrieves a QuickBooks Desktop time report by item, job, or name, with summary
|
|
227
|
+
* or detail rows depending on the selected report type. This report is useful for
|
|
228
|
+
* analyzing tracked time for billing, costing, staffing, or project review.
|
|
194
229
|
*
|
|
195
230
|
* @example
|
|
196
231
|
* ```ts
|
|
@@ -649,18 +684,18 @@ export interface ReportAgingParams {
|
|
|
649
684
|
conductorEndUserId: string;
|
|
650
685
|
|
|
651
686
|
/**
|
|
652
|
-
* Query param: Filter
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
656
|
-
*
|
|
687
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
688
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
689
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
690
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
691
|
+
* `accountIds`, or `accountFullNames`.
|
|
657
692
|
*/
|
|
658
693
|
accountFullNames?: Array<string>;
|
|
659
694
|
|
|
660
695
|
/**
|
|
661
|
-
* Query param: Filter
|
|
662
|
-
*
|
|
663
|
-
*
|
|
696
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
697
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
698
|
+
* `accountIds`, or `accountFullNames`.
|
|
664
699
|
*/
|
|
665
700
|
accountIds?: Array<string>;
|
|
666
701
|
|
|
@@ -670,8 +705,8 @@ export interface ReportAgingParams {
|
|
|
670
705
|
accountsToInclude?: 'all' | 'in_use';
|
|
671
706
|
|
|
672
707
|
/**
|
|
673
|
-
* Query param: Filter
|
|
674
|
-
* per request
|
|
708
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
709
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
675
710
|
*/
|
|
676
711
|
accountType?:
|
|
677
712
|
| 'accounts_payable'
|
|
@@ -718,18 +753,17 @@ export interface ReportAgingParams {
|
|
|
718
753
|
agingAsOf?: 'report_end_date' | 'today';
|
|
719
754
|
|
|
720
755
|
/**
|
|
721
|
-
* Query param: Filter
|
|
722
|
-
*
|
|
723
|
-
*
|
|
724
|
-
*
|
|
725
|
-
* request.
|
|
756
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
757
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
758
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
759
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
726
760
|
*/
|
|
727
761
|
classFullNames?: Array<string>;
|
|
728
762
|
|
|
729
763
|
/**
|
|
730
|
-
* Query param: Filter
|
|
731
|
-
*
|
|
732
|
-
*
|
|
764
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
765
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
766
|
+
* `classFullNames`.
|
|
733
767
|
*/
|
|
734
768
|
classIds?: Array<string>;
|
|
735
769
|
|
|
@@ -741,32 +775,34 @@ export interface ReportAgingParams {
|
|
|
741
775
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
742
776
|
|
|
743
777
|
/**
|
|
744
|
-
* Query param: Filter
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
*
|
|
778
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
779
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
780
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
781
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
782
|
+
* `entityFullNames`.
|
|
749
783
|
*/
|
|
750
784
|
entityFullNames?: Array<string>;
|
|
751
785
|
|
|
752
786
|
/**
|
|
753
|
-
* Query param: Filter
|
|
754
|
-
*
|
|
755
|
-
*
|
|
787
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
788
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
789
|
+
* `entityIds`, or `entityFullNames`.
|
|
756
790
|
*/
|
|
757
791
|
entityIds?: Array<string>;
|
|
758
792
|
|
|
759
793
|
/**
|
|
760
|
-
* Query param: Filter
|
|
761
|
-
* employee, or other name.
|
|
794
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
795
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
796
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
762
797
|
*/
|
|
763
798
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
764
799
|
|
|
765
800
|
/**
|
|
766
|
-
* Query param: The
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
*
|
|
801
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
802
|
+
* columns.
|
|
803
|
+
*
|
|
804
|
+
* **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
|
|
805
|
+
* default report columns unless you include them here.
|
|
770
806
|
*/
|
|
771
807
|
includeColumns?: Array<
|
|
772
808
|
| 'account'
|
|
@@ -847,22 +883,24 @@ export interface ReportAgingParams {
|
|
|
847
883
|
>;
|
|
848
884
|
|
|
849
885
|
/**
|
|
850
|
-
* Query param: Filter
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
886
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
887
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
888
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
889
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
890
|
+
* `itemFullNames`.
|
|
854
891
|
*/
|
|
855
892
|
itemFullNames?: Array<string>;
|
|
856
893
|
|
|
857
894
|
/**
|
|
858
|
-
* Query param: Filter
|
|
859
|
-
*
|
|
895
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
896
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
897
|
+
* or `itemFullNames`.
|
|
860
898
|
*/
|
|
861
899
|
itemIds?: Array<string>;
|
|
862
900
|
|
|
863
901
|
/**
|
|
864
|
-
* Query param: Filter
|
|
865
|
-
* request
|
|
902
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
903
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
866
904
|
*/
|
|
867
905
|
itemType?:
|
|
868
906
|
| 'all_except_fixed_asset'
|
|
@@ -879,23 +917,23 @@ export interface ReportAgingParams {
|
|
|
879
917
|
| 'service';
|
|
880
918
|
|
|
881
919
|
/**
|
|
882
|
-
* Query param: Filter
|
|
920
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
883
921
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
884
922
|
* account register.
|
|
885
923
|
*/
|
|
886
924
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
887
925
|
|
|
888
926
|
/**
|
|
889
|
-
* Query param: Filter
|
|
890
|
-
*
|
|
891
|
-
* `reportDateFrom
|
|
892
|
-
* the current fiscal year to date.
|
|
927
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
928
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
929
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
930
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
893
931
|
*/
|
|
894
932
|
reportDateFrom?: string;
|
|
895
933
|
|
|
896
934
|
/**
|
|
897
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
898
|
-
*
|
|
935
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
936
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
899
937
|
*/
|
|
900
938
|
reportDateMacro?:
|
|
901
939
|
| 'all'
|
|
@@ -924,16 +962,16 @@ export interface ReportAgingParams {
|
|
|
924
962
|
| 'next_year';
|
|
925
963
|
|
|
926
964
|
/**
|
|
927
|
-
* Query param: Filter
|
|
928
|
-
*
|
|
929
|
-
* `reportDateFrom
|
|
930
|
-
* the current fiscal year to date.
|
|
965
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
966
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
967
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
968
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
931
969
|
*/
|
|
932
970
|
reportDateTo?: string;
|
|
933
971
|
|
|
934
972
|
/**
|
|
935
|
-
* Query param: Filter
|
|
936
|
-
*
|
|
973
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
974
|
+
* transaction types.
|
|
937
975
|
*/
|
|
938
976
|
transactionTypes?: Array<
|
|
939
977
|
| 'all'
|
|
@@ -967,20 +1005,22 @@ export interface ReportAgingParams {
|
|
|
967
1005
|
>;
|
|
968
1006
|
|
|
969
1007
|
/**
|
|
970
|
-
* Query param: Filter
|
|
971
|
-
* format (YYYY-MM-DD).
|
|
1008
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
1009
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1010
|
+
* `updatedAfter`/`updatedBefore`.
|
|
972
1011
|
*/
|
|
973
1012
|
updatedAfter?: string;
|
|
974
1013
|
|
|
975
1014
|
/**
|
|
976
|
-
* Query param: Filter
|
|
977
|
-
* format (YYYY-MM-DD).
|
|
1015
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
1016
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1017
|
+
* `updatedAfter`/`updatedBefore`.
|
|
978
1018
|
*/
|
|
979
1019
|
updatedBefore?: string;
|
|
980
1020
|
|
|
981
1021
|
/**
|
|
982
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
983
|
-
*
|
|
1022
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
1023
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
984
1024
|
*/
|
|
985
1025
|
updatedDateMacro?:
|
|
986
1026
|
| 'all'
|
|
@@ -1039,32 +1079,31 @@ export interface ReportBudgetSummaryParams {
|
|
|
1039
1079
|
budgetCriterion?: 'accounts' | 'accounts_and_classes' | 'accounts_and_customers';
|
|
1040
1080
|
|
|
1041
1081
|
/**
|
|
1042
|
-
* Query param: Filter
|
|
1043
|
-
*
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
1046
|
-
* request.
|
|
1082
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
1083
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1084
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
1085
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
1047
1086
|
*/
|
|
1048
1087
|
classFullNames?: Array<string>;
|
|
1049
1088
|
|
|
1050
1089
|
/**
|
|
1051
|
-
* Query param: Filter
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1090
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
1091
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
1092
|
+
* `classFullNames`.
|
|
1054
1093
|
*/
|
|
1055
1094
|
classIds?: Array<string>;
|
|
1056
1095
|
|
|
1057
1096
|
/**
|
|
1058
|
-
* Query param: Filter
|
|
1059
|
-
*
|
|
1060
|
-
* `reportDateFrom
|
|
1061
|
-
* the current fiscal year to date.
|
|
1097
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
1098
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1099
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1100
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1062
1101
|
*/
|
|
1063
1102
|
reportDateFrom?: string;
|
|
1064
1103
|
|
|
1065
1104
|
/**
|
|
1066
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
1067
|
-
*
|
|
1105
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
1106
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
1068
1107
|
*/
|
|
1069
1108
|
reportDateMacro?:
|
|
1070
1109
|
| 'all'
|
|
@@ -1093,10 +1132,10 @@ export interface ReportBudgetSummaryParams {
|
|
|
1093
1132
|
| 'next_year';
|
|
1094
1133
|
|
|
1095
1134
|
/**
|
|
1096
|
-
* Query param: Filter
|
|
1097
|
-
*
|
|
1098
|
-
* `reportDateFrom
|
|
1099
|
-
* the current fiscal year to date.
|
|
1135
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
1136
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1137
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1138
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1100
1139
|
*/
|
|
1101
1140
|
reportDateTo?: string;
|
|
1102
1141
|
|
|
@@ -1114,10 +1153,11 @@ export interface ReportBudgetSummaryParams {
|
|
|
1114
1153
|
|
|
1115
1154
|
export interface ReportCustomDetailParams {
|
|
1116
1155
|
/**
|
|
1117
|
-
* Query param: The
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1156
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
1157
|
+
* columns.
|
|
1158
|
+
*
|
|
1159
|
+
* **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
|
|
1160
|
+
* default report columns unless you include them here.
|
|
1121
1161
|
*/
|
|
1122
1162
|
includeColumns: Array<
|
|
1123
1163
|
| 'account'
|
|
@@ -1238,18 +1278,18 @@ export interface ReportCustomDetailParams {
|
|
|
1238
1278
|
conductorEndUserId: string;
|
|
1239
1279
|
|
|
1240
1280
|
/**
|
|
1241
|
-
* Query param: Filter
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1244
|
-
*
|
|
1245
|
-
*
|
|
1281
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
1282
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
1283
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
1284
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
1285
|
+
* `accountIds`, or `accountFullNames`.
|
|
1246
1286
|
*/
|
|
1247
1287
|
accountFullNames?: Array<string>;
|
|
1248
1288
|
|
|
1249
1289
|
/**
|
|
1250
|
-
* Query param: Filter
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1290
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
1291
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
1292
|
+
* `accountIds`, or `accountFullNames`.
|
|
1253
1293
|
*/
|
|
1254
1294
|
accountIds?: Array<string>;
|
|
1255
1295
|
|
|
@@ -1259,8 +1299,8 @@ export interface ReportCustomDetailParams {
|
|
|
1259
1299
|
accountsToInclude?: 'all' | 'in_use';
|
|
1260
1300
|
|
|
1261
1301
|
/**
|
|
1262
|
-
* Query param: Filter
|
|
1263
|
-
* per request
|
|
1302
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
1303
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
1264
1304
|
*/
|
|
1265
1305
|
accountType?:
|
|
1266
1306
|
| 'accounts_payable'
|
|
@@ -1309,18 +1349,17 @@ export interface ReportCustomDetailParams {
|
|
|
1309
1349
|
basis?: 'accrual' | 'cash' | 'none';
|
|
1310
1350
|
|
|
1311
1351
|
/**
|
|
1312
|
-
* Query param: Filter
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
* request.
|
|
1352
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
1353
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1354
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
1355
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
1317
1356
|
*/
|
|
1318
1357
|
classFullNames?: Array<string>;
|
|
1319
1358
|
|
|
1320
1359
|
/**
|
|
1321
|
-
* Query param: Filter
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1360
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
1361
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
1362
|
+
* `classFullNames`.
|
|
1324
1363
|
*/
|
|
1325
1364
|
classIds?: Array<string>;
|
|
1326
1365
|
|
|
@@ -1332,44 +1371,47 @@ export interface ReportCustomDetailParams {
|
|
|
1332
1371
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
1333
1372
|
|
|
1334
1373
|
/**
|
|
1335
|
-
* Query param: Filter
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1374
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
1375
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1376
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
1377
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
1378
|
+
* `entityFullNames`.
|
|
1340
1379
|
*/
|
|
1341
1380
|
entityFullNames?: Array<string>;
|
|
1342
1381
|
|
|
1343
1382
|
/**
|
|
1344
|
-
* Query param: Filter
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1383
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
1384
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
1385
|
+
* `entityIds`, or `entityFullNames`.
|
|
1347
1386
|
*/
|
|
1348
1387
|
entityIds?: Array<string>;
|
|
1349
1388
|
|
|
1350
1389
|
/**
|
|
1351
|
-
* Query param: Filter
|
|
1352
|
-
* employee, or other name.
|
|
1390
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
1391
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
1392
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
1353
1393
|
*/
|
|
1354
1394
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
1355
1395
|
|
|
1356
1396
|
/**
|
|
1357
|
-
* Query param: Filter
|
|
1358
|
-
*
|
|
1359
|
-
*
|
|
1360
|
-
*
|
|
1397
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
1398
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1399
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
1400
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
1401
|
+
* `itemFullNames`.
|
|
1361
1402
|
*/
|
|
1362
1403
|
itemFullNames?: Array<string>;
|
|
1363
1404
|
|
|
1364
1405
|
/**
|
|
1365
|
-
* Query param: Filter
|
|
1366
|
-
*
|
|
1406
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
1407
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
1408
|
+
* or `itemFullNames`.
|
|
1367
1409
|
*/
|
|
1368
1410
|
itemIds?: Array<string>;
|
|
1369
1411
|
|
|
1370
1412
|
/**
|
|
1371
|
-
* Query param: Filter
|
|
1372
|
-
* request
|
|
1413
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
1414
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
1373
1415
|
*/
|
|
1374
1416
|
itemType?:
|
|
1375
1417
|
| 'all_except_fixed_asset'
|
|
@@ -1392,23 +1434,23 @@ export interface ReportCustomDetailParams {
|
|
|
1392
1434
|
openBalanceAsOf?: 'report_end_date' | 'today';
|
|
1393
1435
|
|
|
1394
1436
|
/**
|
|
1395
|
-
* Query param: Filter
|
|
1437
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
1396
1438
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
1397
1439
|
* account register.
|
|
1398
1440
|
*/
|
|
1399
1441
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
1400
1442
|
|
|
1401
1443
|
/**
|
|
1402
|
-
* Query param: Filter
|
|
1403
|
-
*
|
|
1404
|
-
* `reportDateFrom
|
|
1405
|
-
* the current fiscal year to date.
|
|
1444
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
1445
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1446
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1447
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1406
1448
|
*/
|
|
1407
1449
|
reportDateFrom?: string;
|
|
1408
1450
|
|
|
1409
1451
|
/**
|
|
1410
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
1411
|
-
*
|
|
1452
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
1453
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
1412
1454
|
*/
|
|
1413
1455
|
reportDateMacro?:
|
|
1414
1456
|
| 'all'
|
|
@@ -1437,10 +1479,10 @@ export interface ReportCustomDetailParams {
|
|
|
1437
1479
|
| 'next_year';
|
|
1438
1480
|
|
|
1439
1481
|
/**
|
|
1440
|
-
* Query param: Filter
|
|
1441
|
-
*
|
|
1442
|
-
* `reportDateFrom
|
|
1443
|
-
* the current fiscal year to date.
|
|
1482
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
1483
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1484
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1485
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1444
1486
|
*/
|
|
1445
1487
|
reportDateTo?: string;
|
|
1446
1488
|
|
|
@@ -1452,8 +1494,8 @@ export interface ReportCustomDetailParams {
|
|
|
1452
1494
|
reportType?: 'custom_transaction_detail';
|
|
1453
1495
|
|
|
1454
1496
|
/**
|
|
1455
|
-
* Query param: Filter
|
|
1456
|
-
*
|
|
1497
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
1498
|
+
* transaction types.
|
|
1457
1499
|
*/
|
|
1458
1500
|
transactionTypes?: Array<
|
|
1459
1501
|
| 'all'
|
|
@@ -1487,20 +1529,22 @@ export interface ReportCustomDetailParams {
|
|
|
1487
1529
|
>;
|
|
1488
1530
|
|
|
1489
1531
|
/**
|
|
1490
|
-
* Query param: Filter
|
|
1491
|
-
* format (YYYY-MM-DD).
|
|
1532
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
1533
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1534
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1492
1535
|
*/
|
|
1493
1536
|
updatedAfter?: string;
|
|
1494
1537
|
|
|
1495
1538
|
/**
|
|
1496
|
-
* Query param: Filter
|
|
1497
|
-
* format (YYYY-MM-DD).
|
|
1539
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
1540
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1541
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1498
1542
|
*/
|
|
1499
1543
|
updatedBefore?: string;
|
|
1500
1544
|
|
|
1501
1545
|
/**
|
|
1502
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
1503
|
-
*
|
|
1546
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
1547
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
1504
1548
|
*/
|
|
1505
1549
|
updatedDateMacro?:
|
|
1506
1550
|
| 'all'
|
|
@@ -1605,24 +1649,24 @@ export interface ReportCustomSummaryParams {
|
|
|
1605
1649
|
conductorEndUserId: string;
|
|
1606
1650
|
|
|
1607
1651
|
/**
|
|
1608
|
-
* Query param: Filter
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1652
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
1653
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
1654
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
1655
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
1656
|
+
* `accountIds`, or `accountFullNames`.
|
|
1613
1657
|
*/
|
|
1614
1658
|
accountFullNames?: Array<string>;
|
|
1615
1659
|
|
|
1616
1660
|
/**
|
|
1617
|
-
* Query param: Filter
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1661
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
1662
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
1663
|
+
* `accountIds`, or `accountFullNames`.
|
|
1620
1664
|
*/
|
|
1621
1665
|
accountIds?: Array<string>;
|
|
1622
1666
|
|
|
1623
1667
|
/**
|
|
1624
|
-
* Query param: Filter
|
|
1625
|
-
* per request
|
|
1668
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
1669
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
1626
1670
|
*/
|
|
1627
1671
|
accountType?:
|
|
1628
1672
|
| 'accounts_payable'
|
|
@@ -1671,18 +1715,17 @@ export interface ReportCustomSummaryParams {
|
|
|
1671
1715
|
basis?: 'accrual' | 'cash' | 'none';
|
|
1672
1716
|
|
|
1673
1717
|
/**
|
|
1674
|
-
* Query param: Filter
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1677
|
-
*
|
|
1678
|
-
* request.
|
|
1718
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
1719
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1720
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
1721
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
1679
1722
|
*/
|
|
1680
1723
|
classFullNames?: Array<string>;
|
|
1681
1724
|
|
|
1682
1725
|
/**
|
|
1683
|
-
* Query param: Filter
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1726
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
1727
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
1728
|
+
* `classFullNames`.
|
|
1686
1729
|
*/
|
|
1687
1730
|
classIds?: Array<string>;
|
|
1688
1731
|
|
|
@@ -1701,50 +1744,55 @@ export interface ReportCustomSummaryParams {
|
|
|
1701
1744
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
1702
1745
|
|
|
1703
1746
|
/**
|
|
1704
|
-
* Query param: Filter
|
|
1705
|
-
*
|
|
1706
|
-
*
|
|
1707
|
-
*
|
|
1708
|
-
*
|
|
1747
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
1748
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1749
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
1750
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
1751
|
+
* `entityFullNames`.
|
|
1709
1752
|
*/
|
|
1710
1753
|
entityFullNames?: Array<string>;
|
|
1711
1754
|
|
|
1712
1755
|
/**
|
|
1713
|
-
* Query param: Filter
|
|
1714
|
-
*
|
|
1715
|
-
*
|
|
1756
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
1757
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
1758
|
+
* `entityIds`, or `entityFullNames`.
|
|
1716
1759
|
*/
|
|
1717
1760
|
entityIds?: Array<string>;
|
|
1718
1761
|
|
|
1719
1762
|
/**
|
|
1720
|
-
* Query param: Filter
|
|
1721
|
-
* employee, or other name.
|
|
1763
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
1764
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
1765
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
1722
1766
|
*/
|
|
1723
1767
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
1724
1768
|
|
|
1725
1769
|
/**
|
|
1726
|
-
* Query param: Whether to include subcolumns in the report.
|
|
1727
|
-
*
|
|
1770
|
+
* Query param: Whether to include subcolumns in the report.
|
|
1771
|
+
*
|
|
1772
|
+
* **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
|
|
1773
|
+
* compute from other returned values.
|
|
1728
1774
|
*/
|
|
1729
1775
|
includeSubcolumns?: boolean;
|
|
1730
1776
|
|
|
1731
1777
|
/**
|
|
1732
|
-
* Query param: Filter
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1778
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
1779
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1780
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
1781
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
1782
|
+
* `itemFullNames`.
|
|
1736
1783
|
*/
|
|
1737
1784
|
itemFullNames?: Array<string>;
|
|
1738
1785
|
|
|
1739
1786
|
/**
|
|
1740
|
-
* Query param: Filter
|
|
1741
|
-
*
|
|
1787
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
1788
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
1789
|
+
* or `itemFullNames`.
|
|
1742
1790
|
*/
|
|
1743
1791
|
itemIds?: Array<string>;
|
|
1744
1792
|
|
|
1745
1793
|
/**
|
|
1746
|
-
* Query param: Filter
|
|
1747
|
-
* request
|
|
1794
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
1795
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
1748
1796
|
*/
|
|
1749
1797
|
itemType?:
|
|
1750
1798
|
| 'all_except_fixed_asset'
|
|
@@ -1761,7 +1809,7 @@ export interface ReportCustomSummaryParams {
|
|
|
1761
1809
|
| 'service';
|
|
1762
1810
|
|
|
1763
1811
|
/**
|
|
1764
|
-
* Query param: Filter
|
|
1812
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
1765
1813
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
1766
1814
|
* account register.
|
|
1767
1815
|
*/
|
|
@@ -1773,16 +1821,16 @@ export interface ReportCustomSummaryParams {
|
|
|
1773
1821
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
1774
1822
|
|
|
1775
1823
|
/**
|
|
1776
|
-
* Query param: Filter
|
|
1777
|
-
*
|
|
1778
|
-
* `reportDateFrom
|
|
1779
|
-
* the current fiscal year to date.
|
|
1824
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
1825
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1826
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1827
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1780
1828
|
*/
|
|
1781
1829
|
reportDateFrom?: string;
|
|
1782
1830
|
|
|
1783
1831
|
/**
|
|
1784
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
1785
|
-
*
|
|
1832
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
1833
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
1786
1834
|
*/
|
|
1787
1835
|
reportDateMacro?:
|
|
1788
1836
|
| 'all'
|
|
@@ -1811,10 +1859,10 @@ export interface ReportCustomSummaryParams {
|
|
|
1811
1859
|
| 'next_year';
|
|
1812
1860
|
|
|
1813
1861
|
/**
|
|
1814
|
-
* Query param: Filter
|
|
1815
|
-
*
|
|
1816
|
-
* `reportDateFrom
|
|
1817
|
-
* the current fiscal year to date.
|
|
1862
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
1863
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1864
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1865
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1818
1866
|
*/
|
|
1819
1867
|
reportDateTo?: string;
|
|
1820
1868
|
|
|
@@ -1832,8 +1880,8 @@ export interface ReportCustomSummaryParams {
|
|
|
1832
1880
|
rowsToReturn?: 'active_only' | 'non_zero' | 'all';
|
|
1833
1881
|
|
|
1834
1882
|
/**
|
|
1835
|
-
* Query param: Filter
|
|
1836
|
-
*
|
|
1883
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
1884
|
+
* transaction types.
|
|
1837
1885
|
*/
|
|
1838
1886
|
transactionTypes?: Array<
|
|
1839
1887
|
| 'all'
|
|
@@ -1867,20 +1915,22 @@ export interface ReportCustomSummaryParams {
|
|
|
1867
1915
|
>;
|
|
1868
1916
|
|
|
1869
1917
|
/**
|
|
1870
|
-
* Query param: Filter
|
|
1871
|
-
* format (YYYY-MM-DD).
|
|
1918
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
1919
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1920
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1872
1921
|
*/
|
|
1873
1922
|
updatedAfter?: string;
|
|
1874
1923
|
|
|
1875
1924
|
/**
|
|
1876
|
-
* Query param: Filter
|
|
1877
|
-
* format (YYYY-MM-DD).
|
|
1925
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
1926
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1927
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1878
1928
|
*/
|
|
1879
1929
|
updatedBefore?: string;
|
|
1880
1930
|
|
|
1881
1931
|
/**
|
|
1882
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
1883
|
-
*
|
|
1932
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
1933
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
1884
1934
|
*/
|
|
1885
1935
|
updatedDateMacro?:
|
|
1886
1936
|
| 'all'
|
|
@@ -1955,18 +2005,18 @@ export interface ReportGeneralDetailParams {
|
|
|
1955
2005
|
conductorEndUserId: string;
|
|
1956
2006
|
|
|
1957
2007
|
/**
|
|
1958
|
-
* Query param: Filter
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
1961
|
-
*
|
|
1962
|
-
*
|
|
2008
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
2009
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
2010
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
2011
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
2012
|
+
* `accountIds`, or `accountFullNames`.
|
|
1963
2013
|
*/
|
|
1964
2014
|
accountFullNames?: Array<string>;
|
|
1965
2015
|
|
|
1966
2016
|
/**
|
|
1967
|
-
* Query param: Filter
|
|
1968
|
-
*
|
|
1969
|
-
*
|
|
2017
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
2018
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
2019
|
+
* `accountIds`, or `accountFullNames`.
|
|
1970
2020
|
*/
|
|
1971
2021
|
accountIds?: Array<string>;
|
|
1972
2022
|
|
|
@@ -1976,8 +2026,8 @@ export interface ReportGeneralDetailParams {
|
|
|
1976
2026
|
accountsToInclude?: 'all' | 'in_use';
|
|
1977
2027
|
|
|
1978
2028
|
/**
|
|
1979
|
-
* Query param: Filter
|
|
1980
|
-
* per request
|
|
2029
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
2030
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
1981
2031
|
*/
|
|
1982
2032
|
accountType?:
|
|
1983
2033
|
| 'accounts_payable'
|
|
@@ -2026,18 +2076,17 @@ export interface ReportGeneralDetailParams {
|
|
|
2026
2076
|
basis?: 'accrual' | 'cash' | 'none';
|
|
2027
2077
|
|
|
2028
2078
|
/**
|
|
2029
|
-
* Query param: Filter
|
|
2030
|
-
*
|
|
2031
|
-
*
|
|
2032
|
-
*
|
|
2033
|
-
* request.
|
|
2079
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
2080
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2081
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
2082
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
2034
2083
|
*/
|
|
2035
2084
|
classFullNames?: Array<string>;
|
|
2036
2085
|
|
|
2037
2086
|
/**
|
|
2038
|
-
* Query param: Filter
|
|
2039
|
-
*
|
|
2040
|
-
*
|
|
2087
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
2088
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
2089
|
+
* `classFullNames`.
|
|
2041
2090
|
*/
|
|
2042
2091
|
classIds?: Array<string>;
|
|
2043
2092
|
|
|
@@ -2049,32 +2098,34 @@ export interface ReportGeneralDetailParams {
|
|
|
2049
2098
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
2050
2099
|
|
|
2051
2100
|
/**
|
|
2052
|
-
* Query param: Filter
|
|
2053
|
-
*
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2101
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
2102
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2103
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
2104
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
2105
|
+
* `entityFullNames`.
|
|
2057
2106
|
*/
|
|
2058
2107
|
entityFullNames?: Array<string>;
|
|
2059
2108
|
|
|
2060
2109
|
/**
|
|
2061
|
-
* Query param: Filter
|
|
2062
|
-
*
|
|
2063
|
-
*
|
|
2110
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
2111
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
2112
|
+
* `entityIds`, or `entityFullNames`.
|
|
2064
2113
|
*/
|
|
2065
2114
|
entityIds?: Array<string>;
|
|
2066
2115
|
|
|
2067
2116
|
/**
|
|
2068
|
-
* Query param: Filter
|
|
2069
|
-
* employee, or other name.
|
|
2117
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
2118
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
2119
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
2070
2120
|
*/
|
|
2071
2121
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
2072
2122
|
|
|
2073
2123
|
/**
|
|
2074
|
-
* Query param: The
|
|
2075
|
-
*
|
|
2076
|
-
*
|
|
2077
|
-
*
|
|
2124
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
2125
|
+
* columns.
|
|
2126
|
+
*
|
|
2127
|
+
* **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
|
|
2128
|
+
* default report columns unless you include them here.
|
|
2078
2129
|
*/
|
|
2079
2130
|
includeColumns?: Array<
|
|
2080
2131
|
| 'account'
|
|
@@ -2155,22 +2206,24 @@ export interface ReportGeneralDetailParams {
|
|
|
2155
2206
|
>;
|
|
2156
2207
|
|
|
2157
2208
|
/**
|
|
2158
|
-
* Query param: Filter
|
|
2159
|
-
*
|
|
2160
|
-
*
|
|
2161
|
-
*
|
|
2209
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
2210
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2211
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
2212
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
2213
|
+
* `itemFullNames`.
|
|
2162
2214
|
*/
|
|
2163
2215
|
itemFullNames?: Array<string>;
|
|
2164
2216
|
|
|
2165
2217
|
/**
|
|
2166
|
-
* Query param: Filter
|
|
2167
|
-
*
|
|
2218
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
2219
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
2220
|
+
* or `itemFullNames`.
|
|
2168
2221
|
*/
|
|
2169
2222
|
itemIds?: Array<string>;
|
|
2170
2223
|
|
|
2171
2224
|
/**
|
|
2172
|
-
* Query param: Filter
|
|
2173
|
-
* request
|
|
2225
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
2226
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
2174
2227
|
*/
|
|
2175
2228
|
itemType?:
|
|
2176
2229
|
| 'all_except_fixed_asset'
|
|
@@ -2193,23 +2246,23 @@ export interface ReportGeneralDetailParams {
|
|
|
2193
2246
|
openBalanceAsOf?: 'report_end_date' | 'today';
|
|
2194
2247
|
|
|
2195
2248
|
/**
|
|
2196
|
-
* Query param: Filter
|
|
2249
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
2197
2250
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
2198
2251
|
* account register.
|
|
2199
2252
|
*/
|
|
2200
2253
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
2201
2254
|
|
|
2202
2255
|
/**
|
|
2203
|
-
* Query param: Filter
|
|
2204
|
-
*
|
|
2205
|
-
* `reportDateFrom
|
|
2206
|
-
* the current fiscal year to date.
|
|
2256
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
2257
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2258
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2259
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2207
2260
|
*/
|
|
2208
2261
|
reportDateFrom?: string;
|
|
2209
2262
|
|
|
2210
2263
|
/**
|
|
2211
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
2212
|
-
*
|
|
2264
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
2265
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
2213
2266
|
*/
|
|
2214
2267
|
reportDateMacro?:
|
|
2215
2268
|
| 'all'
|
|
@@ -2238,10 +2291,10 @@ export interface ReportGeneralDetailParams {
|
|
|
2238
2291
|
| 'next_year';
|
|
2239
2292
|
|
|
2240
2293
|
/**
|
|
2241
|
-
* Query param: Filter
|
|
2242
|
-
*
|
|
2243
|
-
* `reportDateFrom
|
|
2244
|
-
* the current fiscal year to date.
|
|
2294
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
2295
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2296
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2297
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2245
2298
|
*/
|
|
2246
2299
|
reportDateTo?: string;
|
|
2247
2300
|
|
|
@@ -2281,8 +2334,8 @@ export interface ReportGeneralDetailParams {
|
|
|
2281
2334
|
| 'year';
|
|
2282
2335
|
|
|
2283
2336
|
/**
|
|
2284
|
-
* Query param: Filter
|
|
2285
|
-
*
|
|
2337
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
2338
|
+
* transaction types.
|
|
2286
2339
|
*/
|
|
2287
2340
|
transactionTypes?: Array<
|
|
2288
2341
|
| 'all'
|
|
@@ -2316,20 +2369,22 @@ export interface ReportGeneralDetailParams {
|
|
|
2316
2369
|
>;
|
|
2317
2370
|
|
|
2318
2371
|
/**
|
|
2319
|
-
* Query param: Filter
|
|
2320
|
-
* format (YYYY-MM-DD).
|
|
2372
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
2373
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2374
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2321
2375
|
*/
|
|
2322
2376
|
updatedAfter?: string;
|
|
2323
2377
|
|
|
2324
2378
|
/**
|
|
2325
|
-
* Query param: Filter
|
|
2326
|
-
* format (YYYY-MM-DD).
|
|
2379
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
2380
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2381
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2327
2382
|
*/
|
|
2328
2383
|
updatedBefore?: string;
|
|
2329
2384
|
|
|
2330
2385
|
/**
|
|
2331
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
2332
|
-
*
|
|
2386
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
2387
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
2333
2388
|
*/
|
|
2334
2389
|
updatedDateMacro?:
|
|
2335
2390
|
| 'all'
|
|
@@ -2399,24 +2454,24 @@ export interface ReportGeneralSummaryParams {
|
|
|
2399
2454
|
conductorEndUserId: string;
|
|
2400
2455
|
|
|
2401
2456
|
/**
|
|
2402
|
-
* Query param: Filter
|
|
2403
|
-
*
|
|
2404
|
-
*
|
|
2405
|
-
*
|
|
2406
|
-
*
|
|
2457
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
2458
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
2459
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
2460
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
2461
|
+
* `accountIds`, or `accountFullNames`.
|
|
2407
2462
|
*/
|
|
2408
2463
|
accountFullNames?: Array<string>;
|
|
2409
2464
|
|
|
2410
2465
|
/**
|
|
2411
|
-
* Query param: Filter
|
|
2412
|
-
*
|
|
2413
|
-
*
|
|
2466
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
2467
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
2468
|
+
* `accountIds`, or `accountFullNames`.
|
|
2414
2469
|
*/
|
|
2415
2470
|
accountIds?: Array<string>;
|
|
2416
2471
|
|
|
2417
2472
|
/**
|
|
2418
|
-
* Query param: Filter
|
|
2419
|
-
* per request
|
|
2473
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
2474
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
2420
2475
|
*/
|
|
2421
2476
|
accountType?:
|
|
2422
2477
|
| 'accounts_payable'
|
|
@@ -2465,18 +2520,17 @@ export interface ReportGeneralSummaryParams {
|
|
|
2465
2520
|
basis?: 'accrual' | 'cash' | 'none';
|
|
2466
2521
|
|
|
2467
2522
|
/**
|
|
2468
|
-
* Query param: Filter
|
|
2469
|
-
*
|
|
2470
|
-
*
|
|
2471
|
-
*
|
|
2472
|
-
* request.
|
|
2523
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
2524
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2525
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
2526
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
2473
2527
|
*/
|
|
2474
2528
|
classFullNames?: Array<string>;
|
|
2475
2529
|
|
|
2476
2530
|
/**
|
|
2477
|
-
* Query param: Filter
|
|
2478
|
-
*
|
|
2479
|
-
*
|
|
2531
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
2532
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
2533
|
+
* `classFullNames`.
|
|
2480
2534
|
*/
|
|
2481
2535
|
classIds?: Array<string>;
|
|
2482
2536
|
|
|
@@ -2495,50 +2549,55 @@ export interface ReportGeneralSummaryParams {
|
|
|
2495
2549
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
2496
2550
|
|
|
2497
2551
|
/**
|
|
2498
|
-
* Query param: Filter
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2552
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
2553
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2554
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
2555
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
2556
|
+
* `entityFullNames`.
|
|
2503
2557
|
*/
|
|
2504
2558
|
entityFullNames?: Array<string>;
|
|
2505
2559
|
|
|
2506
2560
|
/**
|
|
2507
|
-
* Query param: Filter
|
|
2508
|
-
*
|
|
2509
|
-
*
|
|
2561
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
2562
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
2563
|
+
* `entityIds`, or `entityFullNames`.
|
|
2510
2564
|
*/
|
|
2511
2565
|
entityIds?: Array<string>;
|
|
2512
2566
|
|
|
2513
2567
|
/**
|
|
2514
|
-
* Query param: Filter
|
|
2515
|
-
* employee, or other name.
|
|
2568
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
2569
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
2570
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
2516
2571
|
*/
|
|
2517
2572
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
2518
2573
|
|
|
2519
2574
|
/**
|
|
2520
|
-
* Query param: Whether to include subcolumns in the report.
|
|
2521
|
-
*
|
|
2575
|
+
* Query param: Whether to include subcolumns in the report.
|
|
2576
|
+
*
|
|
2577
|
+
* **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
|
|
2578
|
+
* compute from other returned values.
|
|
2522
2579
|
*/
|
|
2523
2580
|
includeSubcolumns?: boolean;
|
|
2524
2581
|
|
|
2525
2582
|
/**
|
|
2526
|
-
* Query param: Filter
|
|
2527
|
-
*
|
|
2528
|
-
*
|
|
2529
|
-
*
|
|
2583
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
2584
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2585
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
2586
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
2587
|
+
* `itemFullNames`.
|
|
2530
2588
|
*/
|
|
2531
2589
|
itemFullNames?: Array<string>;
|
|
2532
2590
|
|
|
2533
2591
|
/**
|
|
2534
|
-
* Query param: Filter
|
|
2535
|
-
*
|
|
2592
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
2593
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
2594
|
+
* or `itemFullNames`.
|
|
2536
2595
|
*/
|
|
2537
2596
|
itemIds?: Array<string>;
|
|
2538
2597
|
|
|
2539
2598
|
/**
|
|
2540
|
-
* Query param: Filter
|
|
2541
|
-
* request
|
|
2599
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
2600
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
2542
2601
|
*/
|
|
2543
2602
|
itemType?:
|
|
2544
2603
|
| 'all_except_fixed_asset'
|
|
@@ -2555,7 +2614,7 @@ export interface ReportGeneralSummaryParams {
|
|
|
2555
2614
|
| 'service';
|
|
2556
2615
|
|
|
2557
2616
|
/**
|
|
2558
|
-
* Query param: Filter
|
|
2617
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
2559
2618
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
2560
2619
|
* account register.
|
|
2561
2620
|
*/
|
|
@@ -2567,16 +2626,16 @@ export interface ReportGeneralSummaryParams {
|
|
|
2567
2626
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
2568
2627
|
|
|
2569
2628
|
/**
|
|
2570
|
-
* Query param: Filter
|
|
2571
|
-
*
|
|
2572
|
-
* `reportDateFrom
|
|
2573
|
-
* the current fiscal year to date.
|
|
2629
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
2630
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2631
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2632
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2574
2633
|
*/
|
|
2575
2634
|
reportDateFrom?: string;
|
|
2576
2635
|
|
|
2577
2636
|
/**
|
|
2578
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
2579
|
-
*
|
|
2637
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
2638
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
2580
2639
|
*/
|
|
2581
2640
|
reportDateMacro?:
|
|
2582
2641
|
| 'all'
|
|
@@ -2605,10 +2664,10 @@ export interface ReportGeneralSummaryParams {
|
|
|
2605
2664
|
| 'next_year';
|
|
2606
2665
|
|
|
2607
2666
|
/**
|
|
2608
|
-
* Query param: Filter
|
|
2609
|
-
*
|
|
2610
|
-
* `reportDateFrom
|
|
2611
|
-
* the current fiscal year to date.
|
|
2667
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
2668
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2669
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2670
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2612
2671
|
*/
|
|
2613
2672
|
reportDateTo?: string;
|
|
2614
2673
|
|
|
@@ -2653,8 +2712,8 @@ export interface ReportGeneralSummaryParams {
|
|
|
2653
2712
|
| 'year';
|
|
2654
2713
|
|
|
2655
2714
|
/**
|
|
2656
|
-
* Query param: Filter
|
|
2657
|
-
*
|
|
2715
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
2716
|
+
* transaction types.
|
|
2658
2717
|
*/
|
|
2659
2718
|
transactionTypes?: Array<
|
|
2660
2719
|
| 'all'
|
|
@@ -2688,20 +2747,22 @@ export interface ReportGeneralSummaryParams {
|
|
|
2688
2747
|
>;
|
|
2689
2748
|
|
|
2690
2749
|
/**
|
|
2691
|
-
* Query param: Filter
|
|
2692
|
-
* format (YYYY-MM-DD).
|
|
2750
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
2751
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2752
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2693
2753
|
*/
|
|
2694
2754
|
updatedAfter?: string;
|
|
2695
2755
|
|
|
2696
2756
|
/**
|
|
2697
|
-
* Query param: Filter
|
|
2698
|
-
* format (YYYY-MM-DD).
|
|
2757
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
2758
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2759
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2699
2760
|
*/
|
|
2700
2761
|
updatedBefore?: string;
|
|
2701
2762
|
|
|
2702
2763
|
/**
|
|
2703
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
2704
|
-
*
|
|
2764
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
2765
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
2705
2766
|
*/
|
|
2706
2767
|
updatedDateMacro?:
|
|
2707
2768
|
| 'all'
|
|
@@ -2748,24 +2809,24 @@ export interface ReportJobParams {
|
|
|
2748
2809
|
conductorEndUserId: string;
|
|
2749
2810
|
|
|
2750
2811
|
/**
|
|
2751
|
-
* Query param: Filter
|
|
2752
|
-
*
|
|
2753
|
-
*
|
|
2754
|
-
*
|
|
2755
|
-
*
|
|
2812
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
2813
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
2814
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
2815
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
2816
|
+
* `accountIds`, or `accountFullNames`.
|
|
2756
2817
|
*/
|
|
2757
2818
|
accountFullNames?: Array<string>;
|
|
2758
2819
|
|
|
2759
2820
|
/**
|
|
2760
|
-
* Query param: Filter
|
|
2761
|
-
*
|
|
2762
|
-
*
|
|
2821
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
2822
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
2823
|
+
* `accountIds`, or `accountFullNames`.
|
|
2763
2824
|
*/
|
|
2764
2825
|
accountIds?: Array<string>;
|
|
2765
2826
|
|
|
2766
2827
|
/**
|
|
2767
|
-
* Query param: Filter
|
|
2768
|
-
* per request
|
|
2828
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
2829
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
2769
2830
|
*/
|
|
2770
2831
|
accountType?:
|
|
2771
2832
|
| 'accounts_payable'
|
|
@@ -2806,18 +2867,17 @@ export interface ReportJobParams {
|
|
|
2806
2867
|
| 'other_income_or_expense';
|
|
2807
2868
|
|
|
2808
2869
|
/**
|
|
2809
|
-
* Query param: Filter
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
2812
|
-
*
|
|
2813
|
-
* request.
|
|
2870
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
2871
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2872
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
2873
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
2814
2874
|
*/
|
|
2815
2875
|
classFullNames?: Array<string>;
|
|
2816
2876
|
|
|
2817
2877
|
/**
|
|
2818
|
-
* Query param: Filter
|
|
2819
|
-
*
|
|
2820
|
-
*
|
|
2878
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
2879
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
2880
|
+
* `classFullNames`.
|
|
2821
2881
|
*/
|
|
2822
2882
|
classIds?: Array<string>;
|
|
2823
2883
|
|
|
@@ -2829,50 +2889,55 @@ export interface ReportJobParams {
|
|
|
2829
2889
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
2830
2890
|
|
|
2831
2891
|
/**
|
|
2832
|
-
* Query param: Filter
|
|
2833
|
-
*
|
|
2834
|
-
*
|
|
2835
|
-
*
|
|
2836
|
-
*
|
|
2892
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
2893
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2894
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
2895
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
2896
|
+
* `entityFullNames`.
|
|
2837
2897
|
*/
|
|
2838
2898
|
entityFullNames?: Array<string>;
|
|
2839
2899
|
|
|
2840
2900
|
/**
|
|
2841
|
-
* Query param: Filter
|
|
2842
|
-
*
|
|
2843
|
-
*
|
|
2901
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
2902
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
2903
|
+
* `entityIds`, or `entityFullNames`.
|
|
2844
2904
|
*/
|
|
2845
2905
|
entityIds?: Array<string>;
|
|
2846
2906
|
|
|
2847
2907
|
/**
|
|
2848
|
-
* Query param: Filter
|
|
2849
|
-
* employee, or other name.
|
|
2908
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
2909
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
2910
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
2850
2911
|
*/
|
|
2851
2912
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
2852
2913
|
|
|
2853
2914
|
/**
|
|
2854
|
-
* Query param: Whether to include subcolumns in the report.
|
|
2855
|
-
*
|
|
2915
|
+
* Query param: Whether to include subcolumns in the report.
|
|
2916
|
+
*
|
|
2917
|
+
* **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
|
|
2918
|
+
* compute from other returned values.
|
|
2856
2919
|
*/
|
|
2857
2920
|
includeSubcolumns?: boolean;
|
|
2858
2921
|
|
|
2859
2922
|
/**
|
|
2860
|
-
* Query param: Filter
|
|
2861
|
-
*
|
|
2862
|
-
*
|
|
2863
|
-
*
|
|
2923
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
2924
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2925
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
2926
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
2927
|
+
* `itemFullNames`.
|
|
2864
2928
|
*/
|
|
2865
2929
|
itemFullNames?: Array<string>;
|
|
2866
2930
|
|
|
2867
2931
|
/**
|
|
2868
|
-
* Query param: Filter
|
|
2869
|
-
*
|
|
2932
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
2933
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
2934
|
+
* or `itemFullNames`.
|
|
2870
2935
|
*/
|
|
2871
2936
|
itemIds?: Array<string>;
|
|
2872
2937
|
|
|
2873
2938
|
/**
|
|
2874
|
-
* Query param: Filter
|
|
2875
|
-
* request
|
|
2939
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
2940
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
2876
2941
|
*/
|
|
2877
2942
|
itemType?:
|
|
2878
2943
|
| 'all_except_fixed_asset'
|
|
@@ -2889,23 +2954,23 @@ export interface ReportJobParams {
|
|
|
2889
2954
|
| 'service';
|
|
2890
2955
|
|
|
2891
2956
|
/**
|
|
2892
|
-
* Query param: Filter
|
|
2957
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
2893
2958
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
2894
2959
|
* account register.
|
|
2895
2960
|
*/
|
|
2896
2961
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
2897
2962
|
|
|
2898
2963
|
/**
|
|
2899
|
-
* Query param: Filter
|
|
2900
|
-
*
|
|
2901
|
-
* `reportDateFrom
|
|
2902
|
-
* the current fiscal year to date.
|
|
2964
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
2965
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2966
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2967
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2903
2968
|
*/
|
|
2904
2969
|
reportDateFrom?: string;
|
|
2905
2970
|
|
|
2906
2971
|
/**
|
|
2907
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
2908
|
-
*
|
|
2972
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
2973
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
2909
2974
|
*/
|
|
2910
2975
|
reportDateMacro?:
|
|
2911
2976
|
| 'all'
|
|
@@ -2934,10 +2999,10 @@ export interface ReportJobParams {
|
|
|
2934
2999
|
| 'next_year';
|
|
2935
3000
|
|
|
2936
3001
|
/**
|
|
2937
|
-
* Query param: Filter
|
|
2938
|
-
*
|
|
2939
|
-
* `reportDateFrom
|
|
2940
|
-
* the current fiscal year to date.
|
|
3002
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3003
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3004
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3005
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2941
3006
|
*/
|
|
2942
3007
|
reportDateTo?: string;
|
|
2943
3008
|
|
|
@@ -2976,8 +3041,8 @@ export interface ReportJobParams {
|
|
|
2976
3041
|
| 'year';
|
|
2977
3042
|
|
|
2978
3043
|
/**
|
|
2979
|
-
* Query param: Filter
|
|
2980
|
-
*
|
|
3044
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
3045
|
+
* transaction types.
|
|
2981
3046
|
*/
|
|
2982
3047
|
transactionTypes?: Array<
|
|
2983
3048
|
| 'all'
|
|
@@ -3011,20 +3076,22 @@ export interface ReportJobParams {
|
|
|
3011
3076
|
>;
|
|
3012
3077
|
|
|
3013
3078
|
/**
|
|
3014
|
-
* Query param: Filter
|
|
3015
|
-
* format (YYYY-MM-DD).
|
|
3079
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
3080
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3081
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3016
3082
|
*/
|
|
3017
3083
|
updatedAfter?: string;
|
|
3018
3084
|
|
|
3019
3085
|
/**
|
|
3020
|
-
* Query param: Filter
|
|
3021
|
-
* format (YYYY-MM-DD).
|
|
3086
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
3087
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3088
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3022
3089
|
*/
|
|
3023
3090
|
updatedBefore?: string;
|
|
3024
3091
|
|
|
3025
3092
|
/**
|
|
3026
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
3027
|
-
*
|
|
3093
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
3094
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
3028
3095
|
*/
|
|
3029
3096
|
updatedDateMacro?:
|
|
3030
3097
|
| 'all'
|
|
@@ -3070,18 +3137,18 @@ export interface ReportPayrollDetailParams {
|
|
|
3070
3137
|
conductorEndUserId: string;
|
|
3071
3138
|
|
|
3072
3139
|
/**
|
|
3073
|
-
* Query param: Filter
|
|
3074
|
-
*
|
|
3075
|
-
*
|
|
3076
|
-
*
|
|
3077
|
-
*
|
|
3140
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
3141
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
3142
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
3143
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
3144
|
+
* `accountIds`, or `accountFullNames`.
|
|
3078
3145
|
*/
|
|
3079
3146
|
accountFullNames?: Array<string>;
|
|
3080
3147
|
|
|
3081
3148
|
/**
|
|
3082
|
-
* Query param: Filter
|
|
3083
|
-
*
|
|
3084
|
-
*
|
|
3149
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
3150
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
3151
|
+
* `accountIds`, or `accountFullNames`.
|
|
3085
3152
|
*/
|
|
3086
3153
|
accountIds?: Array<string>;
|
|
3087
3154
|
|
|
@@ -3091,8 +3158,8 @@ export interface ReportPayrollDetailParams {
|
|
|
3091
3158
|
accountsToInclude?: 'all' | 'in_use';
|
|
3092
3159
|
|
|
3093
3160
|
/**
|
|
3094
|
-
* Query param: Filter
|
|
3095
|
-
* per request
|
|
3161
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
3162
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
3096
3163
|
*/
|
|
3097
3164
|
accountType?:
|
|
3098
3165
|
| 'accounts_payable'
|
|
@@ -3133,18 +3200,17 @@ export interface ReportPayrollDetailParams {
|
|
|
3133
3200
|
| 'other_income_or_expense';
|
|
3134
3201
|
|
|
3135
3202
|
/**
|
|
3136
|
-
* Query param: Filter
|
|
3137
|
-
*
|
|
3138
|
-
*
|
|
3139
|
-
*
|
|
3140
|
-
* request.
|
|
3203
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
3204
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3205
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
3206
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
3141
3207
|
*/
|
|
3142
3208
|
classFullNames?: Array<string>;
|
|
3143
3209
|
|
|
3144
3210
|
/**
|
|
3145
|
-
* Query param: Filter
|
|
3146
|
-
*
|
|
3147
|
-
*
|
|
3211
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
3212
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
3213
|
+
* `classFullNames`.
|
|
3148
3214
|
*/
|
|
3149
3215
|
classIds?: Array<string>;
|
|
3150
3216
|
|
|
@@ -3156,32 +3222,34 @@ export interface ReportPayrollDetailParams {
|
|
|
3156
3222
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
3157
3223
|
|
|
3158
3224
|
/**
|
|
3159
|
-
* Query param: Filter
|
|
3160
|
-
*
|
|
3161
|
-
*
|
|
3162
|
-
*
|
|
3163
|
-
*
|
|
3225
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
3226
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3227
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
3228
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
3229
|
+
* `entityFullNames`.
|
|
3164
3230
|
*/
|
|
3165
3231
|
entityFullNames?: Array<string>;
|
|
3166
3232
|
|
|
3167
3233
|
/**
|
|
3168
|
-
* Query param: Filter
|
|
3169
|
-
*
|
|
3170
|
-
*
|
|
3234
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
3235
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
3236
|
+
* `entityIds`, or `entityFullNames`.
|
|
3171
3237
|
*/
|
|
3172
3238
|
entityIds?: Array<string>;
|
|
3173
3239
|
|
|
3174
3240
|
/**
|
|
3175
|
-
* Query param: Filter
|
|
3176
|
-
* employee, or other name.
|
|
3241
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
3242
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
3243
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
3177
3244
|
*/
|
|
3178
3245
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
3179
3246
|
|
|
3180
3247
|
/**
|
|
3181
|
-
* Query param: The
|
|
3182
|
-
*
|
|
3183
|
-
*
|
|
3184
|
-
*
|
|
3248
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
3249
|
+
* columns.
|
|
3250
|
+
*
|
|
3251
|
+
* **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
|
|
3252
|
+
* default report columns unless you include them here.
|
|
3185
3253
|
*/
|
|
3186
3254
|
includeColumns?: Array<
|
|
3187
3255
|
| 'account'
|
|
@@ -3262,22 +3330,24 @@ export interface ReportPayrollDetailParams {
|
|
|
3262
3330
|
>;
|
|
3263
3331
|
|
|
3264
3332
|
/**
|
|
3265
|
-
* Query param: Filter
|
|
3266
|
-
*
|
|
3267
|
-
*
|
|
3268
|
-
*
|
|
3333
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
3334
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3335
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
3336
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
3337
|
+
* `itemFullNames`.
|
|
3269
3338
|
*/
|
|
3270
3339
|
itemFullNames?: Array<string>;
|
|
3271
3340
|
|
|
3272
3341
|
/**
|
|
3273
|
-
* Query param: Filter
|
|
3274
|
-
*
|
|
3342
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
3343
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
3344
|
+
* or `itemFullNames`.
|
|
3275
3345
|
*/
|
|
3276
3346
|
itemIds?: Array<string>;
|
|
3277
3347
|
|
|
3278
3348
|
/**
|
|
3279
|
-
* Query param: Filter
|
|
3280
|
-
* request
|
|
3349
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
3350
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
3281
3351
|
*/
|
|
3282
3352
|
itemType?:
|
|
3283
3353
|
| 'all_except_fixed_asset'
|
|
@@ -3300,23 +3370,23 @@ export interface ReportPayrollDetailParams {
|
|
|
3300
3370
|
openBalanceAsOf?: 'report_end_date' | 'today';
|
|
3301
3371
|
|
|
3302
3372
|
/**
|
|
3303
|
-
* Query param: Filter
|
|
3373
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
3304
3374
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
3305
3375
|
* account register.
|
|
3306
3376
|
*/
|
|
3307
3377
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
3308
3378
|
|
|
3309
3379
|
/**
|
|
3310
|
-
* Query param: Filter
|
|
3311
|
-
*
|
|
3312
|
-
* `reportDateFrom
|
|
3313
|
-
* the current fiscal year to date.
|
|
3380
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
3381
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3382
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3383
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3314
3384
|
*/
|
|
3315
3385
|
reportDateFrom?: string;
|
|
3316
3386
|
|
|
3317
3387
|
/**
|
|
3318
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
3319
|
-
*
|
|
3388
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
3389
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
3320
3390
|
*/
|
|
3321
3391
|
reportDateMacro?:
|
|
3322
3392
|
| 'all'
|
|
@@ -3345,10 +3415,10 @@ export interface ReportPayrollDetailParams {
|
|
|
3345
3415
|
| 'next_year';
|
|
3346
3416
|
|
|
3347
3417
|
/**
|
|
3348
|
-
* Query param: Filter
|
|
3349
|
-
*
|
|
3350
|
-
* `reportDateFrom
|
|
3351
|
-
* the current fiscal year to date.
|
|
3418
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3419
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3420
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3421
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3352
3422
|
*/
|
|
3353
3423
|
reportDateTo?: string;
|
|
3354
3424
|
|
|
@@ -3388,20 +3458,22 @@ export interface ReportPayrollDetailParams {
|
|
|
3388
3458
|
| 'year';
|
|
3389
3459
|
|
|
3390
3460
|
/**
|
|
3391
|
-
* Query param: Filter
|
|
3392
|
-
* format (YYYY-MM-DD).
|
|
3461
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
3462
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3463
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3393
3464
|
*/
|
|
3394
3465
|
updatedAfter?: string;
|
|
3395
3466
|
|
|
3396
3467
|
/**
|
|
3397
|
-
* Query param: Filter
|
|
3398
|
-
* format (YYYY-MM-DD).
|
|
3468
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
3469
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3470
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3399
3471
|
*/
|
|
3400
3472
|
updatedBefore?: string;
|
|
3401
3473
|
|
|
3402
3474
|
/**
|
|
3403
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
3404
|
-
*
|
|
3475
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
3476
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
3405
3477
|
*/
|
|
3406
3478
|
updatedDateMacro?:
|
|
3407
3479
|
| 'all'
|
|
@@ -3442,24 +3514,24 @@ export interface ReportPayrollSummaryParams {
|
|
|
3442
3514
|
conductorEndUserId: string;
|
|
3443
3515
|
|
|
3444
3516
|
/**
|
|
3445
|
-
* Query param: Filter
|
|
3446
|
-
*
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3449
|
-
*
|
|
3517
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
3518
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
3519
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
3520
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
3521
|
+
* `accountIds`, or `accountFullNames`.
|
|
3450
3522
|
*/
|
|
3451
3523
|
accountFullNames?: Array<string>;
|
|
3452
3524
|
|
|
3453
3525
|
/**
|
|
3454
|
-
* Query param: Filter
|
|
3455
|
-
*
|
|
3456
|
-
*
|
|
3526
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
3527
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
3528
|
+
* `accountIds`, or `accountFullNames`.
|
|
3457
3529
|
*/
|
|
3458
3530
|
accountIds?: Array<string>;
|
|
3459
3531
|
|
|
3460
3532
|
/**
|
|
3461
|
-
* Query param: Filter
|
|
3462
|
-
* per request
|
|
3533
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
3534
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
3463
3535
|
*/
|
|
3464
3536
|
accountType?:
|
|
3465
3537
|
| 'accounts_payable'
|
|
@@ -3500,18 +3572,17 @@ export interface ReportPayrollSummaryParams {
|
|
|
3500
3572
|
| 'other_income_or_expense';
|
|
3501
3573
|
|
|
3502
3574
|
/**
|
|
3503
|
-
* Query param: Filter
|
|
3504
|
-
*
|
|
3505
|
-
*
|
|
3506
|
-
*
|
|
3507
|
-
* request.
|
|
3575
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
3576
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3577
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
3578
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
3508
3579
|
*/
|
|
3509
3580
|
classFullNames?: Array<string>;
|
|
3510
3581
|
|
|
3511
3582
|
/**
|
|
3512
|
-
* Query param: Filter
|
|
3513
|
-
*
|
|
3514
|
-
*
|
|
3583
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
3584
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
3585
|
+
* `classFullNames`.
|
|
3515
3586
|
*/
|
|
3516
3587
|
classIds?: Array<string>;
|
|
3517
3588
|
|
|
@@ -3530,50 +3601,55 @@ export interface ReportPayrollSummaryParams {
|
|
|
3530
3601
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
3531
3602
|
|
|
3532
3603
|
/**
|
|
3533
|
-
* Query param: Filter
|
|
3534
|
-
*
|
|
3535
|
-
*
|
|
3536
|
-
*
|
|
3537
|
-
*
|
|
3604
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
3605
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3606
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
3607
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
3608
|
+
* `entityFullNames`.
|
|
3538
3609
|
*/
|
|
3539
3610
|
entityFullNames?: Array<string>;
|
|
3540
3611
|
|
|
3541
3612
|
/**
|
|
3542
|
-
* Query param: Filter
|
|
3543
|
-
*
|
|
3544
|
-
*
|
|
3613
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
3614
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
3615
|
+
* `entityIds`, or `entityFullNames`.
|
|
3545
3616
|
*/
|
|
3546
3617
|
entityIds?: Array<string>;
|
|
3547
3618
|
|
|
3548
3619
|
/**
|
|
3549
|
-
* Query param: Filter
|
|
3550
|
-
* employee, or other name.
|
|
3620
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
3621
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
3622
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
3551
3623
|
*/
|
|
3552
3624
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
3553
3625
|
|
|
3554
3626
|
/**
|
|
3555
|
-
* Query param: Whether to include subcolumns in the report.
|
|
3556
|
-
*
|
|
3627
|
+
* Query param: Whether to include subcolumns in the report.
|
|
3628
|
+
*
|
|
3629
|
+
* **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
|
|
3630
|
+
* compute from other returned values.
|
|
3557
3631
|
*/
|
|
3558
3632
|
includeSubcolumns?: boolean;
|
|
3559
3633
|
|
|
3560
3634
|
/**
|
|
3561
|
-
* Query param: Filter
|
|
3562
|
-
*
|
|
3563
|
-
*
|
|
3564
|
-
*
|
|
3635
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
3636
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3637
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
3638
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
3639
|
+
* `itemFullNames`.
|
|
3565
3640
|
*/
|
|
3566
3641
|
itemFullNames?: Array<string>;
|
|
3567
3642
|
|
|
3568
3643
|
/**
|
|
3569
|
-
* Query param: Filter
|
|
3570
|
-
*
|
|
3644
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
3645
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
3646
|
+
* or `itemFullNames`.
|
|
3571
3647
|
*/
|
|
3572
3648
|
itemIds?: Array<string>;
|
|
3573
3649
|
|
|
3574
3650
|
/**
|
|
3575
|
-
* Query param: Filter
|
|
3576
|
-
* request
|
|
3651
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
3652
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
3577
3653
|
*/
|
|
3578
3654
|
itemType?:
|
|
3579
3655
|
| 'all_except_fixed_asset'
|
|
@@ -3590,7 +3666,7 @@ export interface ReportPayrollSummaryParams {
|
|
|
3590
3666
|
| 'service';
|
|
3591
3667
|
|
|
3592
3668
|
/**
|
|
3593
|
-
* Query param: Filter
|
|
3669
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
3594
3670
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
3595
3671
|
* account register.
|
|
3596
3672
|
*/
|
|
@@ -3602,16 +3678,16 @@ export interface ReportPayrollSummaryParams {
|
|
|
3602
3678
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
3603
3679
|
|
|
3604
3680
|
/**
|
|
3605
|
-
* Query param: Filter
|
|
3606
|
-
*
|
|
3607
|
-
* `reportDateFrom
|
|
3608
|
-
* the current fiscal year to date.
|
|
3681
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
3682
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3683
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3684
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3609
3685
|
*/
|
|
3610
3686
|
reportDateFrom?: string;
|
|
3611
3687
|
|
|
3612
3688
|
/**
|
|
3613
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
3614
|
-
*
|
|
3689
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
3690
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
3615
3691
|
*/
|
|
3616
3692
|
reportDateMacro?:
|
|
3617
3693
|
| 'all'
|
|
@@ -3640,10 +3716,10 @@ export interface ReportPayrollSummaryParams {
|
|
|
3640
3716
|
| 'next_year';
|
|
3641
3717
|
|
|
3642
3718
|
/**
|
|
3643
|
-
* Query param: Filter
|
|
3644
|
-
*
|
|
3645
|
-
* `reportDateFrom
|
|
3646
|
-
* the current fiscal year to date.
|
|
3719
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3720
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3721
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3722
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3647
3723
|
*/
|
|
3648
3724
|
reportDateTo?: string;
|
|
3649
3725
|
|
|
@@ -3688,20 +3764,22 @@ export interface ReportPayrollSummaryParams {
|
|
|
3688
3764
|
| 'year';
|
|
3689
3765
|
|
|
3690
3766
|
/**
|
|
3691
|
-
* Query param: Filter
|
|
3692
|
-
* format (YYYY-MM-DD).
|
|
3767
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
3768
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3769
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3693
3770
|
*/
|
|
3694
3771
|
updatedAfter?: string;
|
|
3695
3772
|
|
|
3696
3773
|
/**
|
|
3697
|
-
* Query param: Filter
|
|
3698
|
-
* format (YYYY-MM-DD).
|
|
3774
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
3775
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3776
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3699
3777
|
*/
|
|
3700
3778
|
updatedBefore?: string;
|
|
3701
3779
|
|
|
3702
3780
|
/**
|
|
3703
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
3704
|
-
*
|
|
3781
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
3782
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
3705
3783
|
*/
|
|
3706
3784
|
updatedDateMacro?:
|
|
3707
3785
|
| 'all'
|
|
@@ -3742,18 +3820,17 @@ export interface ReportTimeParams {
|
|
|
3742
3820
|
conductorEndUserId: string;
|
|
3743
3821
|
|
|
3744
3822
|
/**
|
|
3745
|
-
* Query param: Filter
|
|
3746
|
-
*
|
|
3747
|
-
*
|
|
3748
|
-
*
|
|
3749
|
-
* request.
|
|
3823
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
3824
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3825
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
3826
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
3750
3827
|
*/
|
|
3751
3828
|
classFullNames?: Array<string>;
|
|
3752
3829
|
|
|
3753
3830
|
/**
|
|
3754
|
-
* Query param: Filter
|
|
3755
|
-
*
|
|
3756
|
-
*
|
|
3831
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
3832
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
3833
|
+
* `classFullNames`.
|
|
3757
3834
|
*/
|
|
3758
3835
|
classIds?: Array<string>;
|
|
3759
3836
|
|
|
@@ -3765,50 +3842,55 @@ export interface ReportTimeParams {
|
|
|
3765
3842
|
columnsToReturn?: 'active_only' | 'non_zero' | 'all';
|
|
3766
3843
|
|
|
3767
3844
|
/**
|
|
3768
|
-
* Query param: Filter
|
|
3769
|
-
*
|
|
3770
|
-
*
|
|
3771
|
-
*
|
|
3772
|
-
*
|
|
3845
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
3846
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3847
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
3848
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
3849
|
+
* `entityFullNames`.
|
|
3773
3850
|
*/
|
|
3774
3851
|
entityFullNames?: Array<string>;
|
|
3775
3852
|
|
|
3776
3853
|
/**
|
|
3777
|
-
* Query param: Filter
|
|
3778
|
-
*
|
|
3779
|
-
*
|
|
3854
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
3855
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
3856
|
+
* `entityIds`, or `entityFullNames`.
|
|
3780
3857
|
*/
|
|
3781
3858
|
entityIds?: Array<string>;
|
|
3782
3859
|
|
|
3783
3860
|
/**
|
|
3784
|
-
* Query param: Filter
|
|
3785
|
-
* employee, or other name.
|
|
3861
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
3862
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
3863
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
3786
3864
|
*/
|
|
3787
3865
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
3788
3866
|
|
|
3789
3867
|
/**
|
|
3790
|
-
* Query param: Whether to include subcolumns in the report.
|
|
3791
|
-
*
|
|
3868
|
+
* Query param: Whether to include subcolumns in the report.
|
|
3869
|
+
*
|
|
3870
|
+
* **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
|
|
3871
|
+
* compute from other returned values.
|
|
3792
3872
|
*/
|
|
3793
3873
|
includeSubcolumns?: boolean;
|
|
3794
3874
|
|
|
3795
3875
|
/**
|
|
3796
|
-
* Query param: Filter
|
|
3797
|
-
*
|
|
3798
|
-
*
|
|
3799
|
-
*
|
|
3876
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
3877
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3878
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
3879
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
3880
|
+
* `itemFullNames`.
|
|
3800
3881
|
*/
|
|
3801
3882
|
itemFullNames?: Array<string>;
|
|
3802
3883
|
|
|
3803
3884
|
/**
|
|
3804
|
-
* Query param: Filter
|
|
3805
|
-
*
|
|
3885
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
3886
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
3887
|
+
* or `itemFullNames`.
|
|
3806
3888
|
*/
|
|
3807
3889
|
itemIds?: Array<string>;
|
|
3808
3890
|
|
|
3809
3891
|
/**
|
|
3810
|
-
* Query param: Filter
|
|
3811
|
-
* request
|
|
3892
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
3893
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
3812
3894
|
*/
|
|
3813
3895
|
itemType?:
|
|
3814
3896
|
| 'all_except_fixed_asset'
|
|
@@ -3830,16 +3912,16 @@ export interface ReportTimeParams {
|
|
|
3830
3912
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
3831
3913
|
|
|
3832
3914
|
/**
|
|
3833
|
-
* Query param: Filter
|
|
3834
|
-
*
|
|
3835
|
-
* `reportDateFrom
|
|
3836
|
-
* the current fiscal year to date.
|
|
3915
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
3916
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3917
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3918
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3837
3919
|
*/
|
|
3838
3920
|
reportDateFrom?: string;
|
|
3839
3921
|
|
|
3840
3922
|
/**
|
|
3841
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
3842
|
-
*
|
|
3923
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
3924
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
3843
3925
|
*/
|
|
3844
3926
|
reportDateMacro?:
|
|
3845
3927
|
| 'all'
|
|
@@ -3868,10 +3950,10 @@ export interface ReportTimeParams {
|
|
|
3868
3950
|
| 'next_year';
|
|
3869
3951
|
|
|
3870
3952
|
/**
|
|
3871
|
-
* Query param: Filter
|
|
3872
|
-
*
|
|
3873
|
-
* `reportDateFrom
|
|
3874
|
-
* the current fiscal year to date.
|
|
3953
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3954
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3955
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3956
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3875
3957
|
*/
|
|
3876
3958
|
reportDateTo?: string;
|
|
3877
3959
|
|