conductor-node 14.13.0 → 14.14.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 +8 -0
- package/package.json +1 -1
- package/resources/qbd/reports.d.mts +535 -506
- package/resources/qbd/reports.d.mts.map +1 -1
- package/resources/qbd/reports.d.ts +535 -506
- package/resources/qbd/reports.d.ts.map +1 -1
- package/src/resources/qbd/reports.ts +535 -506
- 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
|
@@ -649,18 +649,18 @@ export interface ReportAgingParams {
|
|
|
649
649
|
conductorEndUserId: string;
|
|
650
650
|
|
|
651
651
|
/**
|
|
652
|
-
* Query param: Filter
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
656
|
-
*
|
|
652
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
653
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
654
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
655
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
656
|
+
* `accountIds`, or `accountFullNames`.
|
|
657
657
|
*/
|
|
658
658
|
accountFullNames?: Array<string>;
|
|
659
659
|
|
|
660
660
|
/**
|
|
661
|
-
* Query param: Filter
|
|
662
|
-
*
|
|
663
|
-
*
|
|
661
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
662
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
663
|
+
* `accountIds`, or `accountFullNames`.
|
|
664
664
|
*/
|
|
665
665
|
accountIds?: Array<string>;
|
|
666
666
|
|
|
@@ -670,8 +670,8 @@ export interface ReportAgingParams {
|
|
|
670
670
|
accountsToInclude?: 'all' | 'in_use';
|
|
671
671
|
|
|
672
672
|
/**
|
|
673
|
-
* Query param: Filter
|
|
674
|
-
* per request
|
|
673
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
674
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
675
675
|
*/
|
|
676
676
|
accountType?:
|
|
677
677
|
| 'accounts_payable'
|
|
@@ -718,18 +718,17 @@ export interface ReportAgingParams {
|
|
|
718
718
|
agingAsOf?: 'report_end_date' | 'today';
|
|
719
719
|
|
|
720
720
|
/**
|
|
721
|
-
* Query param: Filter
|
|
722
|
-
*
|
|
723
|
-
*
|
|
724
|
-
*
|
|
725
|
-
* request.
|
|
721
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
722
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
723
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
724
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
726
725
|
*/
|
|
727
726
|
classFullNames?: Array<string>;
|
|
728
727
|
|
|
729
728
|
/**
|
|
730
|
-
* Query param: Filter
|
|
731
|
-
*
|
|
732
|
-
*
|
|
729
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
730
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
731
|
+
* `classFullNames`.
|
|
733
732
|
*/
|
|
734
733
|
classIds?: Array<string>;
|
|
735
734
|
|
|
@@ -741,32 +740,32 @@ export interface ReportAgingParams {
|
|
|
741
740
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
742
741
|
|
|
743
742
|
/**
|
|
744
|
-
* Query param: Filter
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
*
|
|
743
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
744
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
745
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
746
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
747
|
+
* `entityFullNames`.
|
|
749
748
|
*/
|
|
750
749
|
entityFullNames?: Array<string>;
|
|
751
750
|
|
|
752
751
|
/**
|
|
753
|
-
* Query param: Filter
|
|
754
|
-
*
|
|
755
|
-
*
|
|
752
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
753
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
754
|
+
* `entityIds`, or `entityFullNames`.
|
|
756
755
|
*/
|
|
757
756
|
entityIds?: Array<string>;
|
|
758
757
|
|
|
759
758
|
/**
|
|
760
|
-
* Query param: Filter
|
|
761
|
-
* employee, or other name.
|
|
759
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
760
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
761
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
762
762
|
*/
|
|
763
763
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
764
764
|
|
|
765
765
|
/**
|
|
766
|
-
* Query param: The
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
* here.
|
|
766
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
767
|
+
* columns. When this parameter is present, QuickBooks Desktop omits its default
|
|
768
|
+
* report columns unless you include them here.
|
|
770
769
|
*/
|
|
771
770
|
includeColumns?: Array<
|
|
772
771
|
| 'account'
|
|
@@ -847,22 +846,24 @@ export interface ReportAgingParams {
|
|
|
847
846
|
>;
|
|
848
847
|
|
|
849
848
|
/**
|
|
850
|
-
* Query param: Filter
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
849
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
850
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
851
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
852
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
853
|
+
* `itemFullNames`.
|
|
854
854
|
*/
|
|
855
855
|
itemFullNames?: Array<string>;
|
|
856
856
|
|
|
857
857
|
/**
|
|
858
|
-
* Query param: Filter
|
|
859
|
-
*
|
|
858
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
859
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
860
|
+
* or `itemFullNames`.
|
|
860
861
|
*/
|
|
861
862
|
itemIds?: Array<string>;
|
|
862
863
|
|
|
863
864
|
/**
|
|
864
|
-
* Query param: Filter
|
|
865
|
-
* request
|
|
865
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
866
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
866
867
|
*/
|
|
867
868
|
itemType?:
|
|
868
869
|
| 'all_except_fixed_asset'
|
|
@@ -879,23 +880,23 @@ export interface ReportAgingParams {
|
|
|
879
880
|
| 'service';
|
|
880
881
|
|
|
881
882
|
/**
|
|
882
|
-
* Query param: Filter
|
|
883
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
883
884
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
884
885
|
* account register.
|
|
885
886
|
*/
|
|
886
887
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
887
888
|
|
|
888
889
|
/**
|
|
889
|
-
* Query param: Filter
|
|
890
|
-
*
|
|
891
|
-
* `reportDateFrom
|
|
892
|
-
* the current fiscal year to date.
|
|
890
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
891
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
892
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
893
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
893
894
|
*/
|
|
894
895
|
reportDateFrom?: string;
|
|
895
896
|
|
|
896
897
|
/**
|
|
897
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
898
|
-
*
|
|
898
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
899
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
899
900
|
*/
|
|
900
901
|
reportDateMacro?:
|
|
901
902
|
| 'all'
|
|
@@ -924,16 +925,16 @@ export interface ReportAgingParams {
|
|
|
924
925
|
| 'next_year';
|
|
925
926
|
|
|
926
927
|
/**
|
|
927
|
-
* Query param: Filter
|
|
928
|
-
*
|
|
929
|
-
* `reportDateFrom
|
|
930
|
-
* the current fiscal year to date.
|
|
928
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
929
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
930
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
931
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
931
932
|
*/
|
|
932
933
|
reportDateTo?: string;
|
|
933
934
|
|
|
934
935
|
/**
|
|
935
|
-
* Query param: Filter
|
|
936
|
-
*
|
|
936
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
937
|
+
* transaction types.
|
|
937
938
|
*/
|
|
938
939
|
transactionTypes?: Array<
|
|
939
940
|
| 'all'
|
|
@@ -967,20 +968,22 @@ export interface ReportAgingParams {
|
|
|
967
968
|
>;
|
|
968
969
|
|
|
969
970
|
/**
|
|
970
|
-
* Query param: Filter
|
|
971
|
-
* format (YYYY-MM-DD).
|
|
971
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
972
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
973
|
+
* `updatedAfter`/`updatedBefore`.
|
|
972
974
|
*/
|
|
973
975
|
updatedAfter?: string;
|
|
974
976
|
|
|
975
977
|
/**
|
|
976
|
-
* Query param: Filter
|
|
977
|
-
* format (YYYY-MM-DD).
|
|
978
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
979
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
980
|
+
* `updatedAfter`/`updatedBefore`.
|
|
978
981
|
*/
|
|
979
982
|
updatedBefore?: string;
|
|
980
983
|
|
|
981
984
|
/**
|
|
982
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
983
|
-
*
|
|
985
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
986
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
984
987
|
*/
|
|
985
988
|
updatedDateMacro?:
|
|
986
989
|
| 'all'
|
|
@@ -1039,32 +1042,31 @@ export interface ReportBudgetSummaryParams {
|
|
|
1039
1042
|
budgetCriterion?: 'accounts' | 'accounts_and_classes' | 'accounts_and_customers';
|
|
1040
1043
|
|
|
1041
1044
|
/**
|
|
1042
|
-
* Query param: Filter
|
|
1043
|
-
*
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
1046
|
-
* request.
|
|
1045
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
1046
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1047
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
1048
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
1047
1049
|
*/
|
|
1048
1050
|
classFullNames?: Array<string>;
|
|
1049
1051
|
|
|
1050
1052
|
/**
|
|
1051
|
-
* Query param: Filter
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1053
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
1054
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
1055
|
+
* `classFullNames`.
|
|
1054
1056
|
*/
|
|
1055
1057
|
classIds?: Array<string>;
|
|
1056
1058
|
|
|
1057
1059
|
/**
|
|
1058
|
-
* Query param: Filter
|
|
1059
|
-
*
|
|
1060
|
-
* `reportDateFrom
|
|
1061
|
-
* the current fiscal year to date.
|
|
1060
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
1061
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1062
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1063
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1062
1064
|
*/
|
|
1063
1065
|
reportDateFrom?: string;
|
|
1064
1066
|
|
|
1065
1067
|
/**
|
|
1066
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
1067
|
-
*
|
|
1068
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
1069
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
1068
1070
|
*/
|
|
1069
1071
|
reportDateMacro?:
|
|
1070
1072
|
| 'all'
|
|
@@ -1093,10 +1095,10 @@ export interface ReportBudgetSummaryParams {
|
|
|
1093
1095
|
| 'next_year';
|
|
1094
1096
|
|
|
1095
1097
|
/**
|
|
1096
|
-
* Query param: Filter
|
|
1097
|
-
*
|
|
1098
|
-
* `reportDateFrom
|
|
1099
|
-
* the current fiscal year to date.
|
|
1098
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
1099
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1100
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1101
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1100
1102
|
*/
|
|
1101
1103
|
reportDateTo?: string;
|
|
1102
1104
|
|
|
@@ -1114,10 +1116,9 @@ export interface ReportBudgetSummaryParams {
|
|
|
1114
1116
|
|
|
1115
1117
|
export interface ReportCustomDetailParams {
|
|
1116
1118
|
/**
|
|
1117
|
-
* Query param: The
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
* here.
|
|
1119
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
1120
|
+
* columns. When this parameter is present, QuickBooks Desktop omits its default
|
|
1121
|
+
* report columns unless you include them here.
|
|
1121
1122
|
*/
|
|
1122
1123
|
includeColumns: Array<
|
|
1123
1124
|
| 'account'
|
|
@@ -1238,18 +1239,18 @@ export interface ReportCustomDetailParams {
|
|
|
1238
1239
|
conductorEndUserId: string;
|
|
1239
1240
|
|
|
1240
1241
|
/**
|
|
1241
|
-
* Query param: Filter
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1244
|
-
*
|
|
1245
|
-
*
|
|
1242
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
1243
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
1244
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
1245
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
1246
|
+
* `accountIds`, or `accountFullNames`.
|
|
1246
1247
|
*/
|
|
1247
1248
|
accountFullNames?: Array<string>;
|
|
1248
1249
|
|
|
1249
1250
|
/**
|
|
1250
|
-
* Query param: Filter
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1251
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
1252
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
1253
|
+
* `accountIds`, or `accountFullNames`.
|
|
1253
1254
|
*/
|
|
1254
1255
|
accountIds?: Array<string>;
|
|
1255
1256
|
|
|
@@ -1259,8 +1260,8 @@ export interface ReportCustomDetailParams {
|
|
|
1259
1260
|
accountsToInclude?: 'all' | 'in_use';
|
|
1260
1261
|
|
|
1261
1262
|
/**
|
|
1262
|
-
* Query param: Filter
|
|
1263
|
-
* per request
|
|
1263
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
1264
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
1264
1265
|
*/
|
|
1265
1266
|
accountType?:
|
|
1266
1267
|
| 'accounts_payable'
|
|
@@ -1309,18 +1310,17 @@ export interface ReportCustomDetailParams {
|
|
|
1309
1310
|
basis?: 'accrual' | 'cash' | 'none';
|
|
1310
1311
|
|
|
1311
1312
|
/**
|
|
1312
|
-
* Query param: Filter
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
* request.
|
|
1313
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
1314
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1315
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
1316
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
1317
1317
|
*/
|
|
1318
1318
|
classFullNames?: Array<string>;
|
|
1319
1319
|
|
|
1320
1320
|
/**
|
|
1321
|
-
* Query param: Filter
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1321
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
1322
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
1323
|
+
* `classFullNames`.
|
|
1324
1324
|
*/
|
|
1325
1325
|
classIds?: Array<string>;
|
|
1326
1326
|
|
|
@@ -1332,44 +1332,47 @@ export interface ReportCustomDetailParams {
|
|
|
1332
1332
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
1333
1333
|
|
|
1334
1334
|
/**
|
|
1335
|
-
* Query param: Filter
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1335
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
1336
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1337
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
1338
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
1339
|
+
* `entityFullNames`.
|
|
1340
1340
|
*/
|
|
1341
1341
|
entityFullNames?: Array<string>;
|
|
1342
1342
|
|
|
1343
1343
|
/**
|
|
1344
|
-
* Query param: Filter
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1344
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
1345
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
1346
|
+
* `entityIds`, or `entityFullNames`.
|
|
1347
1347
|
*/
|
|
1348
1348
|
entityIds?: Array<string>;
|
|
1349
1349
|
|
|
1350
1350
|
/**
|
|
1351
|
-
* Query param: Filter
|
|
1352
|
-
* employee, or other name.
|
|
1351
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
1352
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
1353
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
1353
1354
|
*/
|
|
1354
1355
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
1355
1356
|
|
|
1356
1357
|
/**
|
|
1357
|
-
* Query param: Filter
|
|
1358
|
-
*
|
|
1359
|
-
*
|
|
1360
|
-
*
|
|
1358
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
1359
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1360
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
1361
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
1362
|
+
* `itemFullNames`.
|
|
1361
1363
|
*/
|
|
1362
1364
|
itemFullNames?: Array<string>;
|
|
1363
1365
|
|
|
1364
1366
|
/**
|
|
1365
|
-
* Query param: Filter
|
|
1366
|
-
*
|
|
1367
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
1368
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
1369
|
+
* or `itemFullNames`.
|
|
1367
1370
|
*/
|
|
1368
1371
|
itemIds?: Array<string>;
|
|
1369
1372
|
|
|
1370
1373
|
/**
|
|
1371
|
-
* Query param: Filter
|
|
1372
|
-
* request
|
|
1374
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
1375
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
1373
1376
|
*/
|
|
1374
1377
|
itemType?:
|
|
1375
1378
|
| 'all_except_fixed_asset'
|
|
@@ -1392,23 +1395,23 @@ export interface ReportCustomDetailParams {
|
|
|
1392
1395
|
openBalanceAsOf?: 'report_end_date' | 'today';
|
|
1393
1396
|
|
|
1394
1397
|
/**
|
|
1395
|
-
* Query param: Filter
|
|
1398
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
1396
1399
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
1397
1400
|
* account register.
|
|
1398
1401
|
*/
|
|
1399
1402
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
1400
1403
|
|
|
1401
1404
|
/**
|
|
1402
|
-
* Query param: Filter
|
|
1403
|
-
*
|
|
1404
|
-
* `reportDateFrom
|
|
1405
|
-
* the current fiscal year to date.
|
|
1405
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
1406
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1407
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1408
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1406
1409
|
*/
|
|
1407
1410
|
reportDateFrom?: string;
|
|
1408
1411
|
|
|
1409
1412
|
/**
|
|
1410
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
1411
|
-
*
|
|
1413
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
1414
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
1412
1415
|
*/
|
|
1413
1416
|
reportDateMacro?:
|
|
1414
1417
|
| 'all'
|
|
@@ -1437,10 +1440,10 @@ export interface ReportCustomDetailParams {
|
|
|
1437
1440
|
| 'next_year';
|
|
1438
1441
|
|
|
1439
1442
|
/**
|
|
1440
|
-
* Query param: Filter
|
|
1441
|
-
*
|
|
1442
|
-
* `reportDateFrom
|
|
1443
|
-
* the current fiscal year to date.
|
|
1443
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
1444
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1445
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1446
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1444
1447
|
*/
|
|
1445
1448
|
reportDateTo?: string;
|
|
1446
1449
|
|
|
@@ -1452,8 +1455,8 @@ export interface ReportCustomDetailParams {
|
|
|
1452
1455
|
reportType?: 'custom_transaction_detail';
|
|
1453
1456
|
|
|
1454
1457
|
/**
|
|
1455
|
-
* Query param: Filter
|
|
1456
|
-
*
|
|
1458
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
1459
|
+
* transaction types.
|
|
1457
1460
|
*/
|
|
1458
1461
|
transactionTypes?: Array<
|
|
1459
1462
|
| 'all'
|
|
@@ -1487,20 +1490,22 @@ export interface ReportCustomDetailParams {
|
|
|
1487
1490
|
>;
|
|
1488
1491
|
|
|
1489
1492
|
/**
|
|
1490
|
-
* Query param: Filter
|
|
1491
|
-
* format (YYYY-MM-DD).
|
|
1493
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
1494
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1495
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1492
1496
|
*/
|
|
1493
1497
|
updatedAfter?: string;
|
|
1494
1498
|
|
|
1495
1499
|
/**
|
|
1496
|
-
* Query param: Filter
|
|
1497
|
-
* format (YYYY-MM-DD).
|
|
1500
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
1501
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1502
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1498
1503
|
*/
|
|
1499
1504
|
updatedBefore?: string;
|
|
1500
1505
|
|
|
1501
1506
|
/**
|
|
1502
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
1503
|
-
*
|
|
1507
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
1508
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
1504
1509
|
*/
|
|
1505
1510
|
updatedDateMacro?:
|
|
1506
1511
|
| 'all'
|
|
@@ -1605,24 +1610,24 @@ export interface ReportCustomSummaryParams {
|
|
|
1605
1610
|
conductorEndUserId: string;
|
|
1606
1611
|
|
|
1607
1612
|
/**
|
|
1608
|
-
* Query param: Filter
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1613
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
1614
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
1615
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
1616
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
1617
|
+
* `accountIds`, or `accountFullNames`.
|
|
1613
1618
|
*/
|
|
1614
1619
|
accountFullNames?: Array<string>;
|
|
1615
1620
|
|
|
1616
1621
|
/**
|
|
1617
|
-
* Query param: Filter
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1622
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
1623
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
1624
|
+
* `accountIds`, or `accountFullNames`.
|
|
1620
1625
|
*/
|
|
1621
1626
|
accountIds?: Array<string>;
|
|
1622
1627
|
|
|
1623
1628
|
/**
|
|
1624
|
-
* Query param: Filter
|
|
1625
|
-
* per request
|
|
1629
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
1630
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
1626
1631
|
*/
|
|
1627
1632
|
accountType?:
|
|
1628
1633
|
| 'accounts_payable'
|
|
@@ -1671,18 +1676,17 @@ export interface ReportCustomSummaryParams {
|
|
|
1671
1676
|
basis?: 'accrual' | 'cash' | 'none';
|
|
1672
1677
|
|
|
1673
1678
|
/**
|
|
1674
|
-
* Query param: Filter
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1677
|
-
*
|
|
1678
|
-
* request.
|
|
1679
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
1680
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1681
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
1682
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
1679
1683
|
*/
|
|
1680
1684
|
classFullNames?: Array<string>;
|
|
1681
1685
|
|
|
1682
1686
|
/**
|
|
1683
|
-
* Query param: Filter
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1687
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
1688
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
1689
|
+
* `classFullNames`.
|
|
1686
1690
|
*/
|
|
1687
1691
|
classIds?: Array<string>;
|
|
1688
1692
|
|
|
@@ -1701,24 +1705,25 @@ export interface ReportCustomSummaryParams {
|
|
|
1701
1705
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
1702
1706
|
|
|
1703
1707
|
/**
|
|
1704
|
-
* Query param: Filter
|
|
1705
|
-
*
|
|
1706
|
-
*
|
|
1707
|
-
*
|
|
1708
|
-
*
|
|
1708
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
1709
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1710
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
1711
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
1712
|
+
* `entityFullNames`.
|
|
1709
1713
|
*/
|
|
1710
1714
|
entityFullNames?: Array<string>;
|
|
1711
1715
|
|
|
1712
1716
|
/**
|
|
1713
|
-
* Query param: Filter
|
|
1714
|
-
*
|
|
1715
|
-
*
|
|
1717
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
1718
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
1719
|
+
* `entityIds`, or `entityFullNames`.
|
|
1716
1720
|
*/
|
|
1717
1721
|
entityIds?: Array<string>;
|
|
1718
1722
|
|
|
1719
1723
|
/**
|
|
1720
|
-
* Query param: Filter
|
|
1721
|
-
* employee, or other name.
|
|
1724
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
1725
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
1726
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
1722
1727
|
*/
|
|
1723
1728
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
1724
1729
|
|
|
@@ -1729,22 +1734,24 @@ export interface ReportCustomSummaryParams {
|
|
|
1729
1734
|
includeSubcolumns?: boolean;
|
|
1730
1735
|
|
|
1731
1736
|
/**
|
|
1732
|
-
* Query param: Filter
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1737
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
1738
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
1739
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
1740
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
1741
|
+
* `itemFullNames`.
|
|
1736
1742
|
*/
|
|
1737
1743
|
itemFullNames?: Array<string>;
|
|
1738
1744
|
|
|
1739
1745
|
/**
|
|
1740
|
-
* Query param: Filter
|
|
1741
|
-
*
|
|
1746
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
1747
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
1748
|
+
* or `itemFullNames`.
|
|
1742
1749
|
*/
|
|
1743
1750
|
itemIds?: Array<string>;
|
|
1744
1751
|
|
|
1745
1752
|
/**
|
|
1746
|
-
* Query param: Filter
|
|
1747
|
-
* request
|
|
1753
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
1754
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
1748
1755
|
*/
|
|
1749
1756
|
itemType?:
|
|
1750
1757
|
| 'all_except_fixed_asset'
|
|
@@ -1761,7 +1768,7 @@ export interface ReportCustomSummaryParams {
|
|
|
1761
1768
|
| 'service';
|
|
1762
1769
|
|
|
1763
1770
|
/**
|
|
1764
|
-
* Query param: Filter
|
|
1771
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
1765
1772
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
1766
1773
|
* account register.
|
|
1767
1774
|
*/
|
|
@@ -1773,16 +1780,16 @@ export interface ReportCustomSummaryParams {
|
|
|
1773
1780
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
1774
1781
|
|
|
1775
1782
|
/**
|
|
1776
|
-
* Query param: Filter
|
|
1777
|
-
*
|
|
1778
|
-
* `reportDateFrom
|
|
1779
|
-
* the current fiscal year to date.
|
|
1783
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
1784
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1785
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1786
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1780
1787
|
*/
|
|
1781
1788
|
reportDateFrom?: string;
|
|
1782
1789
|
|
|
1783
1790
|
/**
|
|
1784
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
1785
|
-
*
|
|
1791
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
1792
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
1786
1793
|
*/
|
|
1787
1794
|
reportDateMacro?:
|
|
1788
1795
|
| 'all'
|
|
@@ -1811,10 +1818,10 @@ export interface ReportCustomSummaryParams {
|
|
|
1811
1818
|
| 'next_year';
|
|
1812
1819
|
|
|
1813
1820
|
/**
|
|
1814
|
-
* Query param: Filter
|
|
1815
|
-
*
|
|
1816
|
-
* `reportDateFrom
|
|
1817
|
-
* the current fiscal year to date.
|
|
1821
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
1822
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
1823
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
1824
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
1818
1825
|
*/
|
|
1819
1826
|
reportDateTo?: string;
|
|
1820
1827
|
|
|
@@ -1832,8 +1839,8 @@ export interface ReportCustomSummaryParams {
|
|
|
1832
1839
|
rowsToReturn?: 'active_only' | 'non_zero' | 'all';
|
|
1833
1840
|
|
|
1834
1841
|
/**
|
|
1835
|
-
* Query param: Filter
|
|
1836
|
-
*
|
|
1842
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
1843
|
+
* transaction types.
|
|
1837
1844
|
*/
|
|
1838
1845
|
transactionTypes?: Array<
|
|
1839
1846
|
| 'all'
|
|
@@ -1867,20 +1874,22 @@ export interface ReportCustomSummaryParams {
|
|
|
1867
1874
|
>;
|
|
1868
1875
|
|
|
1869
1876
|
/**
|
|
1870
|
-
* Query param: Filter
|
|
1871
|
-
* format (YYYY-MM-DD).
|
|
1877
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
1878
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1879
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1872
1880
|
*/
|
|
1873
1881
|
updatedAfter?: string;
|
|
1874
1882
|
|
|
1875
1883
|
/**
|
|
1876
|
-
* Query param: Filter
|
|
1877
|
-
* format (YYYY-MM-DD).
|
|
1884
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
1885
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
1886
|
+
* `updatedAfter`/`updatedBefore`.
|
|
1878
1887
|
*/
|
|
1879
1888
|
updatedBefore?: string;
|
|
1880
1889
|
|
|
1881
1890
|
/**
|
|
1882
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
1883
|
-
*
|
|
1891
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
1892
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
1884
1893
|
*/
|
|
1885
1894
|
updatedDateMacro?:
|
|
1886
1895
|
| 'all'
|
|
@@ -1955,18 +1964,18 @@ export interface ReportGeneralDetailParams {
|
|
|
1955
1964
|
conductorEndUserId: string;
|
|
1956
1965
|
|
|
1957
1966
|
/**
|
|
1958
|
-
* Query param: Filter
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
1961
|
-
*
|
|
1962
|
-
*
|
|
1967
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
1968
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
1969
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
1970
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
1971
|
+
* `accountIds`, or `accountFullNames`.
|
|
1963
1972
|
*/
|
|
1964
1973
|
accountFullNames?: Array<string>;
|
|
1965
1974
|
|
|
1966
1975
|
/**
|
|
1967
|
-
* Query param: Filter
|
|
1968
|
-
*
|
|
1969
|
-
*
|
|
1976
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
1977
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
1978
|
+
* `accountIds`, or `accountFullNames`.
|
|
1970
1979
|
*/
|
|
1971
1980
|
accountIds?: Array<string>;
|
|
1972
1981
|
|
|
@@ -1976,8 +1985,8 @@ export interface ReportGeneralDetailParams {
|
|
|
1976
1985
|
accountsToInclude?: 'all' | 'in_use';
|
|
1977
1986
|
|
|
1978
1987
|
/**
|
|
1979
|
-
* Query param: Filter
|
|
1980
|
-
* per request
|
|
1988
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
1989
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
1981
1990
|
*/
|
|
1982
1991
|
accountType?:
|
|
1983
1992
|
| 'accounts_payable'
|
|
@@ -2026,18 +2035,17 @@ export interface ReportGeneralDetailParams {
|
|
|
2026
2035
|
basis?: 'accrual' | 'cash' | 'none';
|
|
2027
2036
|
|
|
2028
2037
|
/**
|
|
2029
|
-
* Query param: Filter
|
|
2030
|
-
*
|
|
2031
|
-
*
|
|
2032
|
-
*
|
|
2033
|
-
* request.
|
|
2038
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
2039
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2040
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
2041
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
2034
2042
|
*/
|
|
2035
2043
|
classFullNames?: Array<string>;
|
|
2036
2044
|
|
|
2037
2045
|
/**
|
|
2038
|
-
* Query param: Filter
|
|
2039
|
-
*
|
|
2040
|
-
*
|
|
2046
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
2047
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
2048
|
+
* `classFullNames`.
|
|
2041
2049
|
*/
|
|
2042
2050
|
classIds?: Array<string>;
|
|
2043
2051
|
|
|
@@ -2049,32 +2057,32 @@ export interface ReportGeneralDetailParams {
|
|
|
2049
2057
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
2050
2058
|
|
|
2051
2059
|
/**
|
|
2052
|
-
* Query param: Filter
|
|
2053
|
-
*
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2060
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
2061
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2062
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
2063
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
2064
|
+
* `entityFullNames`.
|
|
2057
2065
|
*/
|
|
2058
2066
|
entityFullNames?: Array<string>;
|
|
2059
2067
|
|
|
2060
2068
|
/**
|
|
2061
|
-
* Query param: Filter
|
|
2062
|
-
*
|
|
2063
|
-
*
|
|
2069
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
2070
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
2071
|
+
* `entityIds`, or `entityFullNames`.
|
|
2064
2072
|
*/
|
|
2065
2073
|
entityIds?: Array<string>;
|
|
2066
2074
|
|
|
2067
2075
|
/**
|
|
2068
|
-
* Query param: Filter
|
|
2069
|
-
* employee, or other name.
|
|
2076
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
2077
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
2078
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
2070
2079
|
*/
|
|
2071
2080
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
2072
2081
|
|
|
2073
2082
|
/**
|
|
2074
|
-
* Query param: The
|
|
2075
|
-
*
|
|
2076
|
-
*
|
|
2077
|
-
* here.
|
|
2083
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
2084
|
+
* columns. When this parameter is present, QuickBooks Desktop omits its default
|
|
2085
|
+
* report columns unless you include them here.
|
|
2078
2086
|
*/
|
|
2079
2087
|
includeColumns?: Array<
|
|
2080
2088
|
| 'account'
|
|
@@ -2155,22 +2163,24 @@ export interface ReportGeneralDetailParams {
|
|
|
2155
2163
|
>;
|
|
2156
2164
|
|
|
2157
2165
|
/**
|
|
2158
|
-
* Query param: Filter
|
|
2159
|
-
*
|
|
2160
|
-
*
|
|
2161
|
-
*
|
|
2166
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
2167
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2168
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
2169
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
2170
|
+
* `itemFullNames`.
|
|
2162
2171
|
*/
|
|
2163
2172
|
itemFullNames?: Array<string>;
|
|
2164
2173
|
|
|
2165
2174
|
/**
|
|
2166
|
-
* Query param: Filter
|
|
2167
|
-
*
|
|
2175
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
2176
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
2177
|
+
* or `itemFullNames`.
|
|
2168
2178
|
*/
|
|
2169
2179
|
itemIds?: Array<string>;
|
|
2170
2180
|
|
|
2171
2181
|
/**
|
|
2172
|
-
* Query param: Filter
|
|
2173
|
-
* request
|
|
2182
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
2183
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
2174
2184
|
*/
|
|
2175
2185
|
itemType?:
|
|
2176
2186
|
| 'all_except_fixed_asset'
|
|
@@ -2193,23 +2203,23 @@ export interface ReportGeneralDetailParams {
|
|
|
2193
2203
|
openBalanceAsOf?: 'report_end_date' | 'today';
|
|
2194
2204
|
|
|
2195
2205
|
/**
|
|
2196
|
-
* Query param: Filter
|
|
2206
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
2197
2207
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
2198
2208
|
* account register.
|
|
2199
2209
|
*/
|
|
2200
2210
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
2201
2211
|
|
|
2202
2212
|
/**
|
|
2203
|
-
* Query param: Filter
|
|
2204
|
-
*
|
|
2205
|
-
* `reportDateFrom
|
|
2206
|
-
* the current fiscal year to date.
|
|
2213
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
2214
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2215
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2216
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2207
2217
|
*/
|
|
2208
2218
|
reportDateFrom?: string;
|
|
2209
2219
|
|
|
2210
2220
|
/**
|
|
2211
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
2212
|
-
*
|
|
2221
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
2222
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
2213
2223
|
*/
|
|
2214
2224
|
reportDateMacro?:
|
|
2215
2225
|
| 'all'
|
|
@@ -2238,10 +2248,10 @@ export interface ReportGeneralDetailParams {
|
|
|
2238
2248
|
| 'next_year';
|
|
2239
2249
|
|
|
2240
2250
|
/**
|
|
2241
|
-
* Query param: Filter
|
|
2242
|
-
*
|
|
2243
|
-
* `reportDateFrom
|
|
2244
|
-
* the current fiscal year to date.
|
|
2251
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
2252
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2253
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2254
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2245
2255
|
*/
|
|
2246
2256
|
reportDateTo?: string;
|
|
2247
2257
|
|
|
@@ -2281,8 +2291,8 @@ export interface ReportGeneralDetailParams {
|
|
|
2281
2291
|
| 'year';
|
|
2282
2292
|
|
|
2283
2293
|
/**
|
|
2284
|
-
* Query param: Filter
|
|
2285
|
-
*
|
|
2294
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
2295
|
+
* transaction types.
|
|
2286
2296
|
*/
|
|
2287
2297
|
transactionTypes?: Array<
|
|
2288
2298
|
| 'all'
|
|
@@ -2316,20 +2326,22 @@ export interface ReportGeneralDetailParams {
|
|
|
2316
2326
|
>;
|
|
2317
2327
|
|
|
2318
2328
|
/**
|
|
2319
|
-
* Query param: Filter
|
|
2320
|
-
* format (YYYY-MM-DD).
|
|
2329
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
2330
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2331
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2321
2332
|
*/
|
|
2322
2333
|
updatedAfter?: string;
|
|
2323
2334
|
|
|
2324
2335
|
/**
|
|
2325
|
-
* Query param: Filter
|
|
2326
|
-
* format (YYYY-MM-DD).
|
|
2336
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
2337
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2338
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2327
2339
|
*/
|
|
2328
2340
|
updatedBefore?: string;
|
|
2329
2341
|
|
|
2330
2342
|
/**
|
|
2331
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
2332
|
-
*
|
|
2343
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
2344
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
2333
2345
|
*/
|
|
2334
2346
|
updatedDateMacro?:
|
|
2335
2347
|
| 'all'
|
|
@@ -2399,24 +2411,24 @@ export interface ReportGeneralSummaryParams {
|
|
|
2399
2411
|
conductorEndUserId: string;
|
|
2400
2412
|
|
|
2401
2413
|
/**
|
|
2402
|
-
* Query param: Filter
|
|
2403
|
-
*
|
|
2404
|
-
*
|
|
2405
|
-
*
|
|
2406
|
-
*
|
|
2414
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
2415
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
2416
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
2417
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
2418
|
+
* `accountIds`, or `accountFullNames`.
|
|
2407
2419
|
*/
|
|
2408
2420
|
accountFullNames?: Array<string>;
|
|
2409
2421
|
|
|
2410
2422
|
/**
|
|
2411
|
-
* Query param: Filter
|
|
2412
|
-
*
|
|
2413
|
-
*
|
|
2423
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
2424
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
2425
|
+
* `accountIds`, or `accountFullNames`.
|
|
2414
2426
|
*/
|
|
2415
2427
|
accountIds?: Array<string>;
|
|
2416
2428
|
|
|
2417
2429
|
/**
|
|
2418
|
-
* Query param: Filter
|
|
2419
|
-
* per request
|
|
2430
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
2431
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
2420
2432
|
*/
|
|
2421
2433
|
accountType?:
|
|
2422
2434
|
| 'accounts_payable'
|
|
@@ -2465,18 +2477,17 @@ export interface ReportGeneralSummaryParams {
|
|
|
2465
2477
|
basis?: 'accrual' | 'cash' | 'none';
|
|
2466
2478
|
|
|
2467
2479
|
/**
|
|
2468
|
-
* Query param: Filter
|
|
2469
|
-
*
|
|
2470
|
-
*
|
|
2471
|
-
*
|
|
2472
|
-
* request.
|
|
2480
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
2481
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2482
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
2483
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
2473
2484
|
*/
|
|
2474
2485
|
classFullNames?: Array<string>;
|
|
2475
2486
|
|
|
2476
2487
|
/**
|
|
2477
|
-
* Query param: Filter
|
|
2478
|
-
*
|
|
2479
|
-
*
|
|
2488
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
2489
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
2490
|
+
* `classFullNames`.
|
|
2480
2491
|
*/
|
|
2481
2492
|
classIds?: Array<string>;
|
|
2482
2493
|
|
|
@@ -2495,24 +2506,25 @@ export interface ReportGeneralSummaryParams {
|
|
|
2495
2506
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
2496
2507
|
|
|
2497
2508
|
/**
|
|
2498
|
-
* Query param: Filter
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2509
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
2510
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2511
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
2512
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
2513
|
+
* `entityFullNames`.
|
|
2503
2514
|
*/
|
|
2504
2515
|
entityFullNames?: Array<string>;
|
|
2505
2516
|
|
|
2506
2517
|
/**
|
|
2507
|
-
* Query param: Filter
|
|
2508
|
-
*
|
|
2509
|
-
*
|
|
2518
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
2519
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
2520
|
+
* `entityIds`, or `entityFullNames`.
|
|
2510
2521
|
*/
|
|
2511
2522
|
entityIds?: Array<string>;
|
|
2512
2523
|
|
|
2513
2524
|
/**
|
|
2514
|
-
* Query param: Filter
|
|
2515
|
-
* employee, or other name.
|
|
2525
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
2526
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
2527
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
2516
2528
|
*/
|
|
2517
2529
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
2518
2530
|
|
|
@@ -2523,22 +2535,24 @@ export interface ReportGeneralSummaryParams {
|
|
|
2523
2535
|
includeSubcolumns?: boolean;
|
|
2524
2536
|
|
|
2525
2537
|
/**
|
|
2526
|
-
* Query param: Filter
|
|
2527
|
-
*
|
|
2528
|
-
*
|
|
2529
|
-
*
|
|
2538
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
2539
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2540
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
2541
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
2542
|
+
* `itemFullNames`.
|
|
2530
2543
|
*/
|
|
2531
2544
|
itemFullNames?: Array<string>;
|
|
2532
2545
|
|
|
2533
2546
|
/**
|
|
2534
|
-
* Query param: Filter
|
|
2535
|
-
*
|
|
2547
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
2548
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
2549
|
+
* or `itemFullNames`.
|
|
2536
2550
|
*/
|
|
2537
2551
|
itemIds?: Array<string>;
|
|
2538
2552
|
|
|
2539
2553
|
/**
|
|
2540
|
-
* Query param: Filter
|
|
2541
|
-
* request
|
|
2554
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
2555
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
2542
2556
|
*/
|
|
2543
2557
|
itemType?:
|
|
2544
2558
|
| 'all_except_fixed_asset'
|
|
@@ -2555,7 +2569,7 @@ export interface ReportGeneralSummaryParams {
|
|
|
2555
2569
|
| 'service';
|
|
2556
2570
|
|
|
2557
2571
|
/**
|
|
2558
|
-
* Query param: Filter
|
|
2572
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
2559
2573
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
2560
2574
|
* account register.
|
|
2561
2575
|
*/
|
|
@@ -2567,16 +2581,16 @@ export interface ReportGeneralSummaryParams {
|
|
|
2567
2581
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
2568
2582
|
|
|
2569
2583
|
/**
|
|
2570
|
-
* Query param: Filter
|
|
2571
|
-
*
|
|
2572
|
-
* `reportDateFrom
|
|
2573
|
-
* the current fiscal year to date.
|
|
2584
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
2585
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2586
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2587
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2574
2588
|
*/
|
|
2575
2589
|
reportDateFrom?: string;
|
|
2576
2590
|
|
|
2577
2591
|
/**
|
|
2578
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
2579
|
-
*
|
|
2592
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
2593
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
2580
2594
|
*/
|
|
2581
2595
|
reportDateMacro?:
|
|
2582
2596
|
| 'all'
|
|
@@ -2605,10 +2619,10 @@ export interface ReportGeneralSummaryParams {
|
|
|
2605
2619
|
| 'next_year';
|
|
2606
2620
|
|
|
2607
2621
|
/**
|
|
2608
|
-
* Query param: Filter
|
|
2609
|
-
*
|
|
2610
|
-
* `reportDateFrom
|
|
2611
|
-
* the current fiscal year to date.
|
|
2622
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
2623
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2624
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2625
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2612
2626
|
*/
|
|
2613
2627
|
reportDateTo?: string;
|
|
2614
2628
|
|
|
@@ -2653,8 +2667,8 @@ export interface ReportGeneralSummaryParams {
|
|
|
2653
2667
|
| 'year';
|
|
2654
2668
|
|
|
2655
2669
|
/**
|
|
2656
|
-
* Query param: Filter
|
|
2657
|
-
*
|
|
2670
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
2671
|
+
* transaction types.
|
|
2658
2672
|
*/
|
|
2659
2673
|
transactionTypes?: Array<
|
|
2660
2674
|
| 'all'
|
|
@@ -2688,20 +2702,22 @@ export interface ReportGeneralSummaryParams {
|
|
|
2688
2702
|
>;
|
|
2689
2703
|
|
|
2690
2704
|
/**
|
|
2691
|
-
* Query param: Filter
|
|
2692
|
-
* format (YYYY-MM-DD).
|
|
2705
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
2706
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2707
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2693
2708
|
*/
|
|
2694
2709
|
updatedAfter?: string;
|
|
2695
2710
|
|
|
2696
2711
|
/**
|
|
2697
|
-
* Query param: Filter
|
|
2698
|
-
* format (YYYY-MM-DD).
|
|
2712
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
2713
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
2714
|
+
* `updatedAfter`/`updatedBefore`.
|
|
2699
2715
|
*/
|
|
2700
2716
|
updatedBefore?: string;
|
|
2701
2717
|
|
|
2702
2718
|
/**
|
|
2703
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
2704
|
-
*
|
|
2719
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
2720
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
2705
2721
|
*/
|
|
2706
2722
|
updatedDateMacro?:
|
|
2707
2723
|
| 'all'
|
|
@@ -2748,24 +2764,24 @@ export interface ReportJobParams {
|
|
|
2748
2764
|
conductorEndUserId: string;
|
|
2749
2765
|
|
|
2750
2766
|
/**
|
|
2751
|
-
* Query param: Filter
|
|
2752
|
-
*
|
|
2753
|
-
*
|
|
2754
|
-
*
|
|
2755
|
-
*
|
|
2767
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
2768
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
2769
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
2770
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
2771
|
+
* `accountIds`, or `accountFullNames`.
|
|
2756
2772
|
*/
|
|
2757
2773
|
accountFullNames?: Array<string>;
|
|
2758
2774
|
|
|
2759
2775
|
/**
|
|
2760
|
-
* Query param: Filter
|
|
2761
|
-
*
|
|
2762
|
-
*
|
|
2776
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
2777
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
2778
|
+
* `accountIds`, or `accountFullNames`.
|
|
2763
2779
|
*/
|
|
2764
2780
|
accountIds?: Array<string>;
|
|
2765
2781
|
|
|
2766
2782
|
/**
|
|
2767
|
-
* Query param: Filter
|
|
2768
|
-
* per request
|
|
2783
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
2784
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
2769
2785
|
*/
|
|
2770
2786
|
accountType?:
|
|
2771
2787
|
| 'accounts_payable'
|
|
@@ -2806,18 +2822,17 @@ export interface ReportJobParams {
|
|
|
2806
2822
|
| 'other_income_or_expense';
|
|
2807
2823
|
|
|
2808
2824
|
/**
|
|
2809
|
-
* Query param: Filter
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
2812
|
-
*
|
|
2813
|
-
* request.
|
|
2825
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
2826
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2827
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
2828
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
2814
2829
|
*/
|
|
2815
2830
|
classFullNames?: Array<string>;
|
|
2816
2831
|
|
|
2817
2832
|
/**
|
|
2818
|
-
* Query param: Filter
|
|
2819
|
-
*
|
|
2820
|
-
*
|
|
2833
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
2834
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
2835
|
+
* `classFullNames`.
|
|
2821
2836
|
*/
|
|
2822
2837
|
classIds?: Array<string>;
|
|
2823
2838
|
|
|
@@ -2829,24 +2844,25 @@ export interface ReportJobParams {
|
|
|
2829
2844
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
2830
2845
|
|
|
2831
2846
|
/**
|
|
2832
|
-
* Query param: Filter
|
|
2833
|
-
*
|
|
2834
|
-
*
|
|
2835
|
-
*
|
|
2836
|
-
*
|
|
2847
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
2848
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2849
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
2850
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
2851
|
+
* `entityFullNames`.
|
|
2837
2852
|
*/
|
|
2838
2853
|
entityFullNames?: Array<string>;
|
|
2839
2854
|
|
|
2840
2855
|
/**
|
|
2841
|
-
* Query param: Filter
|
|
2842
|
-
*
|
|
2843
|
-
*
|
|
2856
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
2857
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
2858
|
+
* `entityIds`, or `entityFullNames`.
|
|
2844
2859
|
*/
|
|
2845
2860
|
entityIds?: Array<string>;
|
|
2846
2861
|
|
|
2847
2862
|
/**
|
|
2848
|
-
* Query param: Filter
|
|
2849
|
-
* employee, or other name.
|
|
2863
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
2864
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
2865
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
2850
2866
|
*/
|
|
2851
2867
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
2852
2868
|
|
|
@@ -2857,22 +2873,24 @@ export interface ReportJobParams {
|
|
|
2857
2873
|
includeSubcolumns?: boolean;
|
|
2858
2874
|
|
|
2859
2875
|
/**
|
|
2860
|
-
* Query param: Filter
|
|
2861
|
-
*
|
|
2862
|
-
*
|
|
2863
|
-
*
|
|
2876
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
2877
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
2878
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
2879
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
2880
|
+
* `itemFullNames`.
|
|
2864
2881
|
*/
|
|
2865
2882
|
itemFullNames?: Array<string>;
|
|
2866
2883
|
|
|
2867
2884
|
/**
|
|
2868
|
-
* Query param: Filter
|
|
2869
|
-
*
|
|
2885
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
2886
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
2887
|
+
* or `itemFullNames`.
|
|
2870
2888
|
*/
|
|
2871
2889
|
itemIds?: Array<string>;
|
|
2872
2890
|
|
|
2873
2891
|
/**
|
|
2874
|
-
* Query param: Filter
|
|
2875
|
-
* request
|
|
2892
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
2893
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
2876
2894
|
*/
|
|
2877
2895
|
itemType?:
|
|
2878
2896
|
| 'all_except_fixed_asset'
|
|
@@ -2889,23 +2907,23 @@ export interface ReportJobParams {
|
|
|
2889
2907
|
| 'service';
|
|
2890
2908
|
|
|
2891
2909
|
/**
|
|
2892
|
-
* Query param: Filter
|
|
2910
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
2893
2911
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
2894
2912
|
* account register.
|
|
2895
2913
|
*/
|
|
2896
2914
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
2897
2915
|
|
|
2898
2916
|
/**
|
|
2899
|
-
* Query param: Filter
|
|
2900
|
-
*
|
|
2901
|
-
* `reportDateFrom
|
|
2902
|
-
* the current fiscal year to date.
|
|
2917
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
2918
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2919
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2920
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2903
2921
|
*/
|
|
2904
2922
|
reportDateFrom?: string;
|
|
2905
2923
|
|
|
2906
2924
|
/**
|
|
2907
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
2908
|
-
*
|
|
2925
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
2926
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
2909
2927
|
*/
|
|
2910
2928
|
reportDateMacro?:
|
|
2911
2929
|
| 'all'
|
|
@@ -2934,10 +2952,10 @@ export interface ReportJobParams {
|
|
|
2934
2952
|
| 'next_year';
|
|
2935
2953
|
|
|
2936
2954
|
/**
|
|
2937
|
-
* Query param: Filter
|
|
2938
|
-
*
|
|
2939
|
-
* `reportDateFrom
|
|
2940
|
-
* the current fiscal year to date.
|
|
2955
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
2956
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
2957
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
2958
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
2941
2959
|
*/
|
|
2942
2960
|
reportDateTo?: string;
|
|
2943
2961
|
|
|
@@ -2976,8 +2994,8 @@ export interface ReportJobParams {
|
|
|
2976
2994
|
| 'year';
|
|
2977
2995
|
|
|
2978
2996
|
/**
|
|
2979
|
-
* Query param: Filter
|
|
2980
|
-
*
|
|
2997
|
+
* Query param: Filter report rows by transaction type. Accepts one or more
|
|
2998
|
+
* transaction types.
|
|
2981
2999
|
*/
|
|
2982
3000
|
transactionTypes?: Array<
|
|
2983
3001
|
| 'all'
|
|
@@ -3011,20 +3029,22 @@ export interface ReportJobParams {
|
|
|
3011
3029
|
>;
|
|
3012
3030
|
|
|
3013
3031
|
/**
|
|
3014
|
-
* Query param: Filter
|
|
3015
|
-
* format (YYYY-MM-DD).
|
|
3032
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
3033
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3034
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3016
3035
|
*/
|
|
3017
3036
|
updatedAfter?: string;
|
|
3018
3037
|
|
|
3019
3038
|
/**
|
|
3020
|
-
* Query param: Filter
|
|
3021
|
-
* format (YYYY-MM-DD).
|
|
3039
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
3040
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3041
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3022
3042
|
*/
|
|
3023
3043
|
updatedBefore?: string;
|
|
3024
3044
|
|
|
3025
3045
|
/**
|
|
3026
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
3027
|
-
*
|
|
3046
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
3047
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
3028
3048
|
*/
|
|
3029
3049
|
updatedDateMacro?:
|
|
3030
3050
|
| 'all'
|
|
@@ -3070,18 +3090,18 @@ export interface ReportPayrollDetailParams {
|
|
|
3070
3090
|
conductorEndUserId: string;
|
|
3071
3091
|
|
|
3072
3092
|
/**
|
|
3073
|
-
* Query param: Filter
|
|
3074
|
-
*
|
|
3075
|
-
*
|
|
3076
|
-
*
|
|
3077
|
-
*
|
|
3093
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
3094
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
3095
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
3096
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
3097
|
+
* `accountIds`, or `accountFullNames`.
|
|
3078
3098
|
*/
|
|
3079
3099
|
accountFullNames?: Array<string>;
|
|
3080
3100
|
|
|
3081
3101
|
/**
|
|
3082
|
-
* Query param: Filter
|
|
3083
|
-
*
|
|
3084
|
-
*
|
|
3102
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
3103
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
3104
|
+
* `accountIds`, or `accountFullNames`.
|
|
3085
3105
|
*/
|
|
3086
3106
|
accountIds?: Array<string>;
|
|
3087
3107
|
|
|
@@ -3091,8 +3111,8 @@ export interface ReportPayrollDetailParams {
|
|
|
3091
3111
|
accountsToInclude?: 'all' | 'in_use';
|
|
3092
3112
|
|
|
3093
3113
|
/**
|
|
3094
|
-
* Query param: Filter
|
|
3095
|
-
* per request
|
|
3114
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
3115
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
3096
3116
|
*/
|
|
3097
3117
|
accountType?:
|
|
3098
3118
|
| 'accounts_payable'
|
|
@@ -3133,18 +3153,17 @@ export interface ReportPayrollDetailParams {
|
|
|
3133
3153
|
| 'other_income_or_expense';
|
|
3134
3154
|
|
|
3135
3155
|
/**
|
|
3136
|
-
* Query param: Filter
|
|
3137
|
-
*
|
|
3138
|
-
*
|
|
3139
|
-
*
|
|
3140
|
-
* request.
|
|
3156
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
3157
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3158
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
3159
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
3141
3160
|
*/
|
|
3142
3161
|
classFullNames?: Array<string>;
|
|
3143
3162
|
|
|
3144
3163
|
/**
|
|
3145
|
-
* Query param: Filter
|
|
3146
|
-
*
|
|
3147
|
-
*
|
|
3164
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
3165
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
3166
|
+
* `classFullNames`.
|
|
3148
3167
|
*/
|
|
3149
3168
|
classIds?: Array<string>;
|
|
3150
3169
|
|
|
@@ -3156,32 +3175,32 @@ export interface ReportPayrollDetailParams {
|
|
|
3156
3175
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
3157
3176
|
|
|
3158
3177
|
/**
|
|
3159
|
-
* Query param: Filter
|
|
3160
|
-
*
|
|
3161
|
-
*
|
|
3162
|
-
*
|
|
3163
|
-
*
|
|
3178
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
3179
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3180
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
3181
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
3182
|
+
* `entityFullNames`.
|
|
3164
3183
|
*/
|
|
3165
3184
|
entityFullNames?: Array<string>;
|
|
3166
3185
|
|
|
3167
3186
|
/**
|
|
3168
|
-
* Query param: Filter
|
|
3169
|
-
*
|
|
3170
|
-
*
|
|
3187
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
3188
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
3189
|
+
* `entityIds`, or `entityFullNames`.
|
|
3171
3190
|
*/
|
|
3172
3191
|
entityIds?: Array<string>;
|
|
3173
3192
|
|
|
3174
3193
|
/**
|
|
3175
|
-
* Query param: Filter
|
|
3176
|
-
* employee, or other name.
|
|
3194
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
3195
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
3196
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
3177
3197
|
*/
|
|
3178
3198
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
3179
3199
|
|
|
3180
3200
|
/**
|
|
3181
|
-
* Query param: The
|
|
3182
|
-
*
|
|
3183
|
-
*
|
|
3184
|
-
* here.
|
|
3201
|
+
* Query param: The report columns to include, by column type. Accepts one or more
|
|
3202
|
+
* columns. When this parameter is present, QuickBooks Desktop omits its default
|
|
3203
|
+
* report columns unless you include them here.
|
|
3185
3204
|
*/
|
|
3186
3205
|
includeColumns?: Array<
|
|
3187
3206
|
| 'account'
|
|
@@ -3262,22 +3281,24 @@ export interface ReportPayrollDetailParams {
|
|
|
3262
3281
|
>;
|
|
3263
3282
|
|
|
3264
3283
|
/**
|
|
3265
|
-
* Query param: Filter
|
|
3266
|
-
*
|
|
3267
|
-
*
|
|
3268
|
-
*
|
|
3284
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
3285
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3286
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
3287
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
3288
|
+
* `itemFullNames`.
|
|
3269
3289
|
*/
|
|
3270
3290
|
itemFullNames?: Array<string>;
|
|
3271
3291
|
|
|
3272
3292
|
/**
|
|
3273
|
-
* Query param: Filter
|
|
3274
|
-
*
|
|
3293
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
3294
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
3295
|
+
* or `itemFullNames`.
|
|
3275
3296
|
*/
|
|
3276
3297
|
itemIds?: Array<string>;
|
|
3277
3298
|
|
|
3278
3299
|
/**
|
|
3279
|
-
* Query param: Filter
|
|
3280
|
-
* request
|
|
3300
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
3301
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
3281
3302
|
*/
|
|
3282
3303
|
itemType?:
|
|
3283
3304
|
| 'all_except_fixed_asset'
|
|
@@ -3300,23 +3321,23 @@ export interface ReportPayrollDetailParams {
|
|
|
3300
3321
|
openBalanceAsOf?: 'report_end_date' | 'today';
|
|
3301
3322
|
|
|
3302
3323
|
/**
|
|
3303
|
-
* Query param: Filter
|
|
3324
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
3304
3325
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
3305
3326
|
* account register.
|
|
3306
3327
|
*/
|
|
3307
3328
|
postingStatus?: 'either' | 'non_posting' | 'posting';
|
|
3308
3329
|
|
|
3309
3330
|
/**
|
|
3310
|
-
* Query param: Filter
|
|
3311
|
-
*
|
|
3312
|
-
* `reportDateFrom
|
|
3313
|
-
* the current fiscal year to date.
|
|
3331
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
3332
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3333
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3334
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3314
3335
|
*/
|
|
3315
3336
|
reportDateFrom?: string;
|
|
3316
3337
|
|
|
3317
3338
|
/**
|
|
3318
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
3319
|
-
*
|
|
3339
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
3340
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
3320
3341
|
*/
|
|
3321
3342
|
reportDateMacro?:
|
|
3322
3343
|
| 'all'
|
|
@@ -3345,10 +3366,10 @@ export interface ReportPayrollDetailParams {
|
|
|
3345
3366
|
| 'next_year';
|
|
3346
3367
|
|
|
3347
3368
|
/**
|
|
3348
|
-
* Query param: Filter
|
|
3349
|
-
*
|
|
3350
|
-
* `reportDateFrom
|
|
3351
|
-
* the current fiscal year to date.
|
|
3369
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3370
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3371
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3372
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3352
3373
|
*/
|
|
3353
3374
|
reportDateTo?: string;
|
|
3354
3375
|
|
|
@@ -3388,20 +3409,22 @@ export interface ReportPayrollDetailParams {
|
|
|
3388
3409
|
| 'year';
|
|
3389
3410
|
|
|
3390
3411
|
/**
|
|
3391
|
-
* Query param: Filter
|
|
3392
|
-
* format (YYYY-MM-DD).
|
|
3412
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
3413
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3414
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3393
3415
|
*/
|
|
3394
3416
|
updatedAfter?: string;
|
|
3395
3417
|
|
|
3396
3418
|
/**
|
|
3397
|
-
* Query param: Filter
|
|
3398
|
-
* format (YYYY-MM-DD).
|
|
3419
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
3420
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3421
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3399
3422
|
*/
|
|
3400
3423
|
updatedBefore?: string;
|
|
3401
3424
|
|
|
3402
3425
|
/**
|
|
3403
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
3404
|
-
*
|
|
3426
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
3427
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
3405
3428
|
*/
|
|
3406
3429
|
updatedDateMacro?:
|
|
3407
3430
|
| 'all'
|
|
@@ -3442,24 +3465,24 @@ export interface ReportPayrollSummaryParams {
|
|
|
3442
3465
|
conductorEndUserId: string;
|
|
3443
3466
|
|
|
3444
3467
|
/**
|
|
3445
|
-
* Query param: Filter
|
|
3446
|
-
*
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3449
|
-
*
|
|
3468
|
+
* Query param: Filter report rows by account `fullName` values, case-insensitive.
|
|
3469
|
+
* A `fullName` is a fully qualified QuickBooks name formed by joining parent
|
|
3470
|
+
* object names with the object's `name` using colons. Accepts one or more account
|
|
3471
|
+
* full names. Choose only one account filter per request: `accountType`,
|
|
3472
|
+
* `accountIds`, or `accountFullNames`.
|
|
3450
3473
|
*/
|
|
3451
3474
|
accountFullNames?: Array<string>;
|
|
3452
3475
|
|
|
3453
3476
|
/**
|
|
3454
|
-
* Query param: Filter
|
|
3455
|
-
*
|
|
3456
|
-
*
|
|
3477
|
+
* Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
|
|
3478
|
+
* or more account IDs. Choose only one account filter per request: `accountType`,
|
|
3479
|
+
* `accountIds`, or `accountFullNames`.
|
|
3457
3480
|
*/
|
|
3458
3481
|
accountIds?: Array<string>;
|
|
3459
3482
|
|
|
3460
3483
|
/**
|
|
3461
|
-
* Query param: Filter
|
|
3462
|
-
* per request
|
|
3484
|
+
* Query param: Filter report rows by account type. Choose only one account filter
|
|
3485
|
+
* per request: `accountType`, `accountIds`, or `accountFullNames`.
|
|
3463
3486
|
*/
|
|
3464
3487
|
accountType?:
|
|
3465
3488
|
| 'accounts_payable'
|
|
@@ -3500,18 +3523,17 @@ export interface ReportPayrollSummaryParams {
|
|
|
3500
3523
|
| 'other_income_or_expense';
|
|
3501
3524
|
|
|
3502
3525
|
/**
|
|
3503
|
-
* Query param: Filter
|
|
3504
|
-
*
|
|
3505
|
-
*
|
|
3506
|
-
*
|
|
3507
|
-
* request.
|
|
3526
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
3527
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3528
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
3529
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
3508
3530
|
*/
|
|
3509
3531
|
classFullNames?: Array<string>;
|
|
3510
3532
|
|
|
3511
3533
|
/**
|
|
3512
|
-
* Query param: Filter
|
|
3513
|
-
*
|
|
3514
|
-
*
|
|
3534
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
3535
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
3536
|
+
* `classFullNames`.
|
|
3515
3537
|
*/
|
|
3516
3538
|
classIds?: Array<string>;
|
|
3517
3539
|
|
|
@@ -3530,24 +3552,25 @@ export interface ReportPayrollSummaryParams {
|
|
|
3530
3552
|
detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
|
|
3531
3553
|
|
|
3532
3554
|
/**
|
|
3533
|
-
* Query param: Filter
|
|
3534
|
-
*
|
|
3535
|
-
*
|
|
3536
|
-
*
|
|
3537
|
-
*
|
|
3555
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
3556
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3557
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
3558
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
3559
|
+
* `entityFullNames`.
|
|
3538
3560
|
*/
|
|
3539
3561
|
entityFullNames?: Array<string>;
|
|
3540
3562
|
|
|
3541
3563
|
/**
|
|
3542
|
-
* Query param: Filter
|
|
3543
|
-
*
|
|
3544
|
-
*
|
|
3564
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
3565
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
3566
|
+
* `entityIds`, or `entityFullNames`.
|
|
3545
3567
|
*/
|
|
3546
3568
|
entityIds?: Array<string>;
|
|
3547
3569
|
|
|
3548
3570
|
/**
|
|
3549
|
-
* Query param: Filter
|
|
3550
|
-
* employee, or other name.
|
|
3571
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
3572
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
3573
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
3551
3574
|
*/
|
|
3552
3575
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
3553
3576
|
|
|
@@ -3558,22 +3581,24 @@ export interface ReportPayrollSummaryParams {
|
|
|
3558
3581
|
includeSubcolumns?: boolean;
|
|
3559
3582
|
|
|
3560
3583
|
/**
|
|
3561
|
-
* Query param: Filter
|
|
3562
|
-
*
|
|
3563
|
-
*
|
|
3564
|
-
*
|
|
3584
|
+
* Query param: Filter report rows by item `fullName` values, case-insensitive. A
|
|
3585
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3586
|
+
* names with the object's `name` using colons. Accepts one or more item full
|
|
3587
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
3588
|
+
* `itemFullNames`.
|
|
3565
3589
|
*/
|
|
3566
3590
|
itemFullNames?: Array<string>;
|
|
3567
3591
|
|
|
3568
3592
|
/**
|
|
3569
|
-
* Query param: Filter
|
|
3570
|
-
*
|
|
3593
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
3594
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
3595
|
+
* or `itemFullNames`.
|
|
3571
3596
|
*/
|
|
3572
3597
|
itemIds?: Array<string>;
|
|
3573
3598
|
|
|
3574
3599
|
/**
|
|
3575
|
-
* Query param: Filter
|
|
3576
|
-
* request
|
|
3600
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
3601
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
3577
3602
|
*/
|
|
3578
3603
|
itemType?:
|
|
3579
3604
|
| 'all_except_fixed_asset'
|
|
@@ -3590,7 +3615,7 @@ export interface ReportPayrollSummaryParams {
|
|
|
3590
3615
|
| 'service';
|
|
3591
3616
|
|
|
3592
3617
|
/**
|
|
3593
|
-
* Query param: Filter
|
|
3618
|
+
* Query param: Filter report rows that are posting, non-posting, or either.
|
|
3594
3619
|
* Posting status refers to whether QuickBooks records the transaction in an
|
|
3595
3620
|
* account register.
|
|
3596
3621
|
*/
|
|
@@ -3602,16 +3627,16 @@ export interface ReportPayrollSummaryParams {
|
|
|
3602
3627
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
3603
3628
|
|
|
3604
3629
|
/**
|
|
3605
|
-
* Query param: Filter
|
|
3606
|
-
*
|
|
3607
|
-
* `reportDateFrom
|
|
3608
|
-
* the current fiscal year to date.
|
|
3630
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
3631
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3632
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3633
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3609
3634
|
*/
|
|
3610
3635
|
reportDateFrom?: string;
|
|
3611
3636
|
|
|
3612
3637
|
/**
|
|
3613
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
3614
|
-
*
|
|
3638
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
3639
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
3615
3640
|
*/
|
|
3616
3641
|
reportDateMacro?:
|
|
3617
3642
|
| 'all'
|
|
@@ -3640,10 +3665,10 @@ export interface ReportPayrollSummaryParams {
|
|
|
3640
3665
|
| 'next_year';
|
|
3641
3666
|
|
|
3642
3667
|
/**
|
|
3643
|
-
* Query param: Filter
|
|
3644
|
-
*
|
|
3645
|
-
* `reportDateFrom
|
|
3646
|
-
* the current fiscal year to date.
|
|
3668
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3669
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3670
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3671
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3647
3672
|
*/
|
|
3648
3673
|
reportDateTo?: string;
|
|
3649
3674
|
|
|
@@ -3688,20 +3713,22 @@ export interface ReportPayrollSummaryParams {
|
|
|
3688
3713
|
| 'year';
|
|
3689
3714
|
|
|
3690
3715
|
/**
|
|
3691
|
-
* Query param: Filter
|
|
3692
|
-
* format (YYYY-MM-DD).
|
|
3716
|
+
* Query param: Filter report rows updated on or after this date, in ISO 8601
|
|
3717
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3718
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3693
3719
|
*/
|
|
3694
3720
|
updatedAfter?: string;
|
|
3695
3721
|
|
|
3696
3722
|
/**
|
|
3697
|
-
* Query param: Filter
|
|
3698
|
-
* format (YYYY-MM-DD).
|
|
3723
|
+
* Query param: Filter report rows updated on or before this date, in ISO 8601
|
|
3724
|
+
* format (YYYY-MM-DD). Choose either `updatedDateMacro` or
|
|
3725
|
+
* `updatedAfter`/`updatedBefore`.
|
|
3699
3726
|
*/
|
|
3700
3727
|
updatedBefore?: string;
|
|
3701
3728
|
|
|
3702
3729
|
/**
|
|
3703
|
-
* Query param: A QuickBooks Desktop relative updated-date macro.
|
|
3704
|
-
*
|
|
3730
|
+
* Query param: A QuickBooks Desktop relative updated-date macro. Choose either
|
|
3731
|
+
* `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
|
|
3705
3732
|
*/
|
|
3706
3733
|
updatedDateMacro?:
|
|
3707
3734
|
| 'all'
|
|
@@ -3742,18 +3769,17 @@ export interface ReportTimeParams {
|
|
|
3742
3769
|
conductorEndUserId: string;
|
|
3743
3770
|
|
|
3744
3771
|
/**
|
|
3745
|
-
* Query param: Filter
|
|
3746
|
-
*
|
|
3747
|
-
*
|
|
3748
|
-
*
|
|
3749
|
-
* request.
|
|
3772
|
+
* Query param: Filter report rows by class `fullName` values, case-insensitive. A
|
|
3773
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3774
|
+
* names with the object's `name` using colons. Accepts one or more class full
|
|
3775
|
+
* names. Choose only one class filter per request: `classIds` or `classFullNames`.
|
|
3750
3776
|
*/
|
|
3751
3777
|
classFullNames?: Array<string>;
|
|
3752
3778
|
|
|
3753
3779
|
/**
|
|
3754
|
-
* Query param: Filter
|
|
3755
|
-
*
|
|
3756
|
-
*
|
|
3780
|
+
* Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
|
|
3781
|
+
* more class IDs. Choose only one class filter per request: `classIds` or
|
|
3782
|
+
* `classFullNames`.
|
|
3757
3783
|
*/
|
|
3758
3784
|
classIds?: Array<string>;
|
|
3759
3785
|
|
|
@@ -3765,24 +3791,25 @@ export interface ReportTimeParams {
|
|
|
3765
3791
|
columnsToReturn?: 'active_only' | 'non_zero' | 'all';
|
|
3766
3792
|
|
|
3767
3793
|
/**
|
|
3768
|
-
* Query param: Filter
|
|
3769
|
-
*
|
|
3770
|
-
*
|
|
3771
|
-
*
|
|
3772
|
-
*
|
|
3794
|
+
* Query param: Filter report rows by entity `fullName` values, case-insensitive. A
|
|
3795
|
+
* `fullName` is a fully qualified QuickBooks name formed by joining parent object
|
|
3796
|
+
* names with the object's `name` using colons. Accepts one or more entity full
|
|
3797
|
+
* names. Choose only one entity filter per request: `entityType`, `entityIds`, or
|
|
3798
|
+
* `entityFullNames`.
|
|
3773
3799
|
*/
|
|
3774
3800
|
entityFullNames?: Array<string>;
|
|
3775
3801
|
|
|
3776
3802
|
/**
|
|
3777
|
-
* Query param: Filter
|
|
3778
|
-
*
|
|
3779
|
-
*
|
|
3803
|
+
* Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
|
|
3804
|
+
* or more entity IDs. Choose only one entity filter per request: `entityType`,
|
|
3805
|
+
* `entityIds`, or `entityFullNames`.
|
|
3780
3806
|
*/
|
|
3781
3807
|
entityIds?: Array<string>;
|
|
3782
3808
|
|
|
3783
3809
|
/**
|
|
3784
|
-
* Query param: Filter
|
|
3785
|
-
* employee, or other name.
|
|
3810
|
+
* Query param: Filter report rows by entity type, such as customer, vendor,
|
|
3811
|
+
* employee, or other name. Choose only one entity filter per request:
|
|
3812
|
+
* `entityType`, `entityIds`, or `entityFullNames`.
|
|
3786
3813
|
*/
|
|
3787
3814
|
entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
|
|
3788
3815
|
|
|
@@ -3793,22 +3820,24 @@ export interface ReportTimeParams {
|
|
|
3793
3820
|
includeSubcolumns?: boolean;
|
|
3794
3821
|
|
|
3795
3822
|
/**
|
|
3796
|
-
* Query param: Filter
|
|
3797
|
-
*
|
|
3798
|
-
*
|
|
3799
|
-
*
|
|
3823
|
+
* Query param: Filter report rows by item `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 item full
|
|
3826
|
+
* names. Choose only one item filter per request: `itemType`, `itemIds`, or
|
|
3827
|
+
* `itemFullNames`.
|
|
3800
3828
|
*/
|
|
3801
3829
|
itemFullNames?: Array<string>;
|
|
3802
3830
|
|
|
3803
3831
|
/**
|
|
3804
|
-
* Query param: Filter
|
|
3805
|
-
*
|
|
3832
|
+
* Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
|
|
3833
|
+
* more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
|
|
3834
|
+
* or `itemFullNames`.
|
|
3806
3835
|
*/
|
|
3807
3836
|
itemIds?: Array<string>;
|
|
3808
3837
|
|
|
3809
3838
|
/**
|
|
3810
|
-
* Query param: Filter
|
|
3811
|
-
* request
|
|
3839
|
+
* Query param: Filter report rows by item type. Choose only one item filter per
|
|
3840
|
+
* request: `itemType`, `itemIds`, or `itemFullNames`.
|
|
3812
3841
|
*/
|
|
3813
3842
|
itemType?:
|
|
3814
3843
|
| 'all_except_fixed_asset'
|
|
@@ -3830,16 +3859,16 @@ export interface ReportTimeParams {
|
|
|
3830
3859
|
reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
|
|
3831
3860
|
|
|
3832
3861
|
/**
|
|
3833
|
-
* Query param: Filter
|
|
3834
|
-
*
|
|
3835
|
-
* `reportDateFrom
|
|
3836
|
-
* the current fiscal year to date.
|
|
3862
|
+
* Query param: Filter report rows dated on or after this date, in ISO 8601 format
|
|
3863
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3864
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3865
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3837
3866
|
*/
|
|
3838
3867
|
reportDateFrom?: string;
|
|
3839
3868
|
|
|
3840
3869
|
/**
|
|
3841
|
-
* Query param: A QuickBooks Desktop relative date macro
|
|
3842
|
-
*
|
|
3870
|
+
* Query param: A QuickBooks Desktop relative date macro for the report period.
|
|
3871
|
+
* Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
|
|
3843
3872
|
*/
|
|
3844
3873
|
reportDateMacro?:
|
|
3845
3874
|
| 'all'
|
|
@@ -3868,10 +3897,10 @@ export interface ReportTimeParams {
|
|
|
3868
3897
|
| 'next_year';
|
|
3869
3898
|
|
|
3870
3899
|
/**
|
|
3871
|
-
* Query param: Filter
|
|
3872
|
-
*
|
|
3873
|
-
* `reportDateFrom
|
|
3874
|
-
* the current fiscal year to date.
|
|
3900
|
+
* Query param: Filter report rows dated on or before this date, in ISO 8601 format
|
|
3901
|
+
* (YYYY-MM-DD). Choose either `reportDateMacro` or
|
|
3902
|
+
* `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
|
|
3903
|
+
* and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
|
|
3875
3904
|
*/
|
|
3876
3905
|
reportDateTo?: string;
|
|
3877
3906
|
|