conductor-node 11.6.2 → 11.6.3
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/dist/package.json
CHANGED
|
@@ -2609,6 +2609,40 @@ export default class QbdIntegration extends BaseIntegration {
|
|
|
2609
2609
|
*/
|
|
2610
2610
|
query: (endUserId: string, params?: QbdTypes.TimeTrackingQueryRq) => Promise<NonNullable<QbdTypes.TimeTrackingQueryRs["TimeTrackingRet"]>>;
|
|
2611
2611
|
};
|
|
2612
|
+
/**
|
|
2613
|
+
* A general transaction is a superset of all transaction types in QuickBooks
|
|
2614
|
+
* Desktop.
|
|
2615
|
+
*/
|
|
2616
|
+
transaction: {
|
|
2617
|
+
/**
|
|
2618
|
+
* Queries for transactions across different transaction types. In contrast
|
|
2619
|
+
* to the other transaction-specific queries, this query only returns data
|
|
2620
|
+
* common to all transactions, such as `TxnID`, type, dates, accountRef, and
|
|
2621
|
+
* so on. This query does return condensed transactions.
|
|
2622
|
+
*
|
|
2623
|
+
* Accordingly, if additional and more transaction-specific data is
|
|
2624
|
+
* required, a subsequent call to the desired query can be used to get that
|
|
2625
|
+
* transaction-specific data. For example, this method can be used to
|
|
2626
|
+
* present all transactions in a certain date range, then the user can
|
|
2627
|
+
* select a particular transaction, say an invoice transaction. In response
|
|
2628
|
+
* to this choice, you could do an `InvoiceQuery` to pull up all of the
|
|
2629
|
+
* invoice data.
|
|
2630
|
+
*
|
|
2631
|
+
* You should be aware that permissions are obeyed in this query. So, if you
|
|
2632
|
+
* set the transaction type filter to “All” (or if you don’t set it at all),
|
|
2633
|
+
* the query will be searching only those transaction types that are
|
|
2634
|
+
* permissible types for the user currently logged in. Accordingly, if
|
|
2635
|
+
* instead of “all,” you specify a transaction type that the currently
|
|
2636
|
+
* logged in user is not permitted to access, you will get a runtime error,
|
|
2637
|
+
* even if other permissible transaction types were specified as well.
|
|
2638
|
+
*
|
|
2639
|
+
* Finally, the transaction query is subject to sensitive data access level
|
|
2640
|
+
* restrictions and payroll subscription status.
|
|
2641
|
+
*
|
|
2642
|
+
* See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
|
|
2643
|
+
*/
|
|
2644
|
+
query: (endUserId: string, params?: QbdTypes.TransactionQueryRq) => Promise<NonNullable<QbdTypes.TransactionQueryRs["TransactionRet"]>>;
|
|
2645
|
+
};
|
|
2612
2646
|
/**
|
|
2613
2647
|
* A transfer is a transaction that moves money from one account to another
|
|
2614
2648
|
* account.
|
|
@@ -2614,6 +2614,40 @@ class QbdIntegration extends BaseIntegration_1.default {
|
|
|
2614
2614
|
*/
|
|
2615
2615
|
query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { TimeTrackingQueryRq: params }, "TimeTrackingQueryRs", "TimeTrackingRet"),
|
|
2616
2616
|
};
|
|
2617
|
+
/**
|
|
2618
|
+
* A general transaction is a superset of all transaction types in QuickBooks
|
|
2619
|
+
* Desktop.
|
|
2620
|
+
*/
|
|
2621
|
+
transaction = {
|
|
2622
|
+
/**
|
|
2623
|
+
* Queries for transactions across different transaction types. In contrast
|
|
2624
|
+
* to the other transaction-specific queries, this query only returns data
|
|
2625
|
+
* common to all transactions, such as `TxnID`, type, dates, accountRef, and
|
|
2626
|
+
* so on. This query does return condensed transactions.
|
|
2627
|
+
*
|
|
2628
|
+
* Accordingly, if additional and more transaction-specific data is
|
|
2629
|
+
* required, a subsequent call to the desired query can be used to get that
|
|
2630
|
+
* transaction-specific data. For example, this method can be used to
|
|
2631
|
+
* present all transactions in a certain date range, then the user can
|
|
2632
|
+
* select a particular transaction, say an invoice transaction. In response
|
|
2633
|
+
* to this choice, you could do an `InvoiceQuery` to pull up all of the
|
|
2634
|
+
* invoice data.
|
|
2635
|
+
*
|
|
2636
|
+
* You should be aware that permissions are obeyed in this query. So, if you
|
|
2637
|
+
* set the transaction type filter to “All” (or if you don’t set it at all),
|
|
2638
|
+
* the query will be searching only those transaction types that are
|
|
2639
|
+
* permissible types for the user currently logged in. Accordingly, if
|
|
2640
|
+
* instead of “all,” you specify a transaction type that the currently
|
|
2641
|
+
* logged in user is not permitted to access, you will get a runtime error,
|
|
2642
|
+
* even if other permissible transaction types were specified as well.
|
|
2643
|
+
*
|
|
2644
|
+
* Finally, the transaction query is subject to sensitive data access level
|
|
2645
|
+
* restrictions and payroll subscription status.
|
|
2646
|
+
*
|
|
2647
|
+
* See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
|
|
2648
|
+
*/
|
|
2649
|
+
query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { TransactionQueryRq: params }, "TransactionQueryRs", "TransactionRet"),
|
|
2650
|
+
};
|
|
2617
2651
|
/**
|
|
2618
2652
|
* A transfer is a transaction that moves money from one account to another
|
|
2619
2653
|
* account.
|
|
@@ -12039,8 +12039,241 @@ export interface TotalRow {
|
|
|
12039
12039
|
/** A list of `IColData` objects, each of which describes the data in one cell of the report. */
|
|
12040
12040
|
ColData?: ColData | ColData[];
|
|
12041
12041
|
}
|
|
12042
|
+
export interface TransactionAccountFilter {
|
|
12043
|
+
/** Allows you to report on a specific account type. */
|
|
12044
|
+
AccountTypeFilter?: AccountTypeFilter;
|
|
12045
|
+
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
12046
|
+
|
|
12047
|
+
A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
12048
|
+
ListID?: string[] | string;
|
|
12049
|
+
/** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
12050
|
+
FullName?: string[] | string;
|
|
12051
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. */
|
|
12052
|
+
ListIDWithChildren?: string;
|
|
12053
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
12054
|
+
FullNameWithChildren?: string;
|
|
12055
|
+
}
|
|
12056
|
+
export interface TransactionClassFilter {
|
|
12057
|
+
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
12058
|
+
|
|
12059
|
+
A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
12060
|
+
ListID?: string[] | string;
|
|
12061
|
+
/** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
12062
|
+
FullName?: string[] | string;
|
|
12063
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. */
|
|
12064
|
+
ListIDWithChildren?: string;
|
|
12065
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
12066
|
+
FullNameWithChildren?: string;
|
|
12067
|
+
}
|
|
12068
|
+
export interface TransactionDateRangeFilter {
|
|
12069
|
+
/** Selects transactions created on or after this date. Both `FromTxnDate` and `ToTxnDate` must be between 01/01/1901 and 12/31/9999.
|
|
12070
|
+
|
|
12071
|
+
If you omit `FromTxnDate`, it will be set to 1970-01-01 (1969-12-31 PST). */
|
|
12072
|
+
FromTxnDate?: string;
|
|
12073
|
+
/** Selects transactions created on or before this date. Both `ToTxnDate` and `FromTxnDate` must be between 01/01/1901 and 12/31/9999. If you omit `ToTxnDate`, it will be set to 2038-01-19 (2038-01-18 PST). */
|
|
12074
|
+
ToTxnDate?: string;
|
|
12075
|
+
/** Refers to the transaction date, not the last modification date. Do not include `DateMacro` if either `FromModifedDate` or `ToModifiedDate` are specified. If a query does not specify `DateMacro`, `FromModifedDate`, or `ToModifiedDate`, it includes all dates.
|
|
12076
|
+
|
|
12077
|
+
`DateMacro` values, in alphabetical order, that are new with QBFC3:
|
|
12078
|
+
|
|
12079
|
+
`dmAll`, `dmdmLastCalendarQuarter`, `dmdmLastCalendarQuarterToDate`, `dmdmLastCalendarYear`, `dmdmLastCalendarYearToDate`, `dmLastFiscalQuarterToDate`, `dmLastFiscalYearToDate`, `dmLastMonthToDate`, `dmLastWeekToDate`, `dmNextCalendarQuarter`, `dmNextCalendarYear`, `dmNextFiscalQuarter`, `dmNextFiscalYear`, `dmNextFourWeeks`, `dmNextMonth`, `dmNextWeek`, `dmThisCalendarQuarter`, `dmThisCalendarQuarterToDate`, `dmThisCalendarYear`, dm `ThisCalendarYearToDate`, `dmThisFiscalQuarter`, `dmThisFiscalYear`, `dmThisMonth`, `dmThisWeek`, `dmThisWeekToDate`, `dmToday`, `dmYesterday`
|
|
12080
|
+
|
|
12081
|
+
The list given when you click `IQBENDateMacroType` shows the complete list of valid version 3.0 values. */
|
|
12082
|
+
DateMacro?: DateMacro;
|
|
12083
|
+
}
|
|
12084
|
+
/** @default: SummaryOnly */
|
|
12085
|
+
export type TransactionDetailLevelFilter = "All" | "AllExceptSummary" | "SummaryOnly";
|
|
12086
|
+
export interface TransactionEntityFilter {
|
|
12087
|
+
/** Allows you to report on a specific name type. */
|
|
12088
|
+
EntityTypeFilter?: EntityTypeFilter;
|
|
12089
|
+
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
12090
|
+
|
|
12091
|
+
A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
12092
|
+
ListID?: string[] | string;
|
|
12093
|
+
/** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
12094
|
+
FullName?: string[] | string;
|
|
12095
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. */
|
|
12096
|
+
ListIDWithChildren?: string;
|
|
12097
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
12098
|
+
FullNameWithChildren?: string;
|
|
12099
|
+
}
|
|
12100
|
+
export interface TransactionItemFilter {
|
|
12101
|
+
/** Allows you to report on a specific item type. */
|
|
12102
|
+
ItemTypeFilter?: ItemTypeFilter;
|
|
12103
|
+
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
12104
|
+
|
|
12105
|
+
A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
12106
|
+
ListID?: string[] | string;
|
|
12107
|
+
/** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
12108
|
+
FullName?: string[] | string;
|
|
12109
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. */
|
|
12110
|
+
ListIDWithChildren?: string;
|
|
12111
|
+
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
12112
|
+
FullNameWithChildren?: string;
|
|
12113
|
+
}
|
|
12042
12114
|
/** @default: CardNotPresent */
|
|
12043
12115
|
export type TransactionMode = "CardNotPresent" | "CardPresent";
|
|
12116
|
+
export interface TransactionModifiedDateRangeFilter {
|
|
12117
|
+
/** Selects objects modified on or after this date. See the note below regarding QBFC usage.
|
|
12118
|
+
|
|
12119
|
+
For desktop versions of QuickBooks, the `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of the field was not supported in qbXML version 1.0 or 1.1.) Also, for desktop versions of QuickBooks, if `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
|
|
12120
|
+
|
|
12121
|
+
For QBOE, the `FromModifiedDate` and `ToModifiedDate` must be between 1900-01-01T00:00:00 and 9999-12-31T00:00:00. If `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1900-01-01T00:00:00.
|
|
12122
|
+
|
|
12123
|
+
Note: When specifying this in QBFC, you need to supply the parameter `asDateOnly`, which is a Boolean. If `asDateOnly` is true, the date value will be represented as a date only (without a time). If `asDateOnly` is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The `asDateOnly` parameter is especially useful in the `ToModifiedDate` field of a query: If `asDateOnly` is set to true in the `ToModifiedDate` field of a query, then the query includes elements modified up to the end of the day. If `asDateOnly` is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included). */
|
|
12124
|
+
FromModifiedDate?: string;
|
|
12125
|
+
/** Selects objects modified on or before this date. See the note below on QBFC usage.
|
|
12126
|
+
|
|
12127
|
+
For desktop versions of QuickBooks, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1970 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time portion of the field was not supported in qbXML version 1.0 or 1.1.) If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
|
|
12128
|
+
|
|
12129
|
+
For QBOE, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1900 and 9999-12-31T00:00:00. If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 9999-12-31T00:00:00.
|
|
12130
|
+
|
|
12131
|
+
Note: When specifying this in QBFC, you need to supply the parameter `asDateOnly`, which is a Boolean. If `asDateOnly` is true, the date value will be represented as a date only (without a time). If `asDateOnly` is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The `asDateOnly` parameter is especially useful in the `ToModifiedDate` field of a query: If `asDateOnly` is set to true in the `ToModifiedDate` field of a query, then the query includes elements modified up to the end of the day. If `asDateOnly` is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included). */
|
|
12132
|
+
ToModifiedDate?: string;
|
|
12133
|
+
/** Refers to the transaction date, not the last modification date. Do not include `DateMacro` if either `FromModifedDate` or `ToModifiedDate` are specified. If a query does not specify `DateMacro`, `FromModifedDate`, or `ToModifiedDate`, it includes all dates.
|
|
12134
|
+
|
|
12135
|
+
`DateMacro` values, in alphabetical order, that are new with QBFC3:
|
|
12136
|
+
|
|
12137
|
+
`dmAll`, `dmdmLastCalendarQuarter`, `dmdmLastCalendarQuarterToDate`, `dmdmLastCalendarYear`, `dmdmLastCalendarYearToDate`, `dmLastFiscalQuarterToDate`, `dmLastFiscalYearToDate`, `dmLastMonthToDate`, `dmLastWeekToDate`, `dmNextCalendarQuarter`, `dmNextCalendarYear`, `dmNextFiscalQuarter`, `dmNextFiscalYear`, `dmNextFourWeeks`, `dmNextMonth`, `dmNextWeek`, `dmThisCalendarQuarter`, `dmThisCalendarQuarterToDate`, `dmThisCalendarYear`, dm `ThisCalendarYearToDate`, `dmThisFiscalQuarter`, `dmThisFiscalYear`, `dmThisMonth`, `dmThisWeek`, `dmThisWeekToDate`, `dmToday`, `dmYesterday`
|
|
12138
|
+
|
|
12139
|
+
The list given when you click `IQBENDateMacroType` shows the complete list of valid version 3.0 values. */
|
|
12140
|
+
DateMacro?: DateMacro;
|
|
12141
|
+
}
|
|
12142
|
+
/** @default: Either */
|
|
12143
|
+
export type TransactionPaidStatusFilter = "Closed" | "Either" | "Open";
|
|
12144
|
+
/** @default: Either */
|
|
12145
|
+
export type TransactionPostingStatusFilter = "Either" | "NonPosting" | "Posting";
|
|
12146
|
+
export interface TransactionQueryRq {
|
|
12147
|
+
/** One or more `TxnID` values. QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks.
|
|
12148
|
+
|
|
12149
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQuery` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
12150
|
+
TxnID?: string[] | string;
|
|
12151
|
+
/** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
|
|
12152
|
+
MaxReturned?: number;
|
|
12153
|
+
/** A list of one or more `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
12154
|
+
|
|
12155
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request, the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
12156
|
+
RefNumber?: string[] | string;
|
|
12157
|
+
/** A list of one or more case sensitive `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
12158
|
+
|
|
12159
|
+
You should use this case sensitive ref number list rather than the older `RefNumber` list, because it provides much better performance in certain circumstances. The older `refNumber` list provided slow performance if the `refNumber` values contained letters, not just digits. This `RefNumberCaseSensitive` list, new in SDK 4.0, eliminates this performance hit. */
|
|
12160
|
+
RefNumberCaseSensitive?: string[] | string;
|
|
12161
|
+
/** Filters according to `RefNumber`. */
|
|
12162
|
+
RefNumberFilter?: RefNumberFilter;
|
|
12163
|
+
/** Filters according to `RefNumber`. The filtering code will do a numerical comparison (if `FromRefNumber` and `ToRefNumber` only contain digits) or a lexicographical comparison (if either `FromRefNumber` or `ToRefNumber` contain any nondigit characters). In the first situation, if you need to query for a `RefNumber` that is larger than the maximum long integer value of 2147483647, one workaround is to specify a `FromRefNumber` that is less than or equal to 2147483647 without specifying a `ToRefNumber`. */
|
|
12164
|
+
RefNumberRangeFilter?: RefNumberRangeFilter;
|
|
12165
|
+
/** Filters the transactions based on the transaction’s modified datetime, either by specifying a “from” and/or “to” date or by using a `DateMacro`. */
|
|
12166
|
+
TransactionModifiedDateRangeFilter?: TransactionModifiedDateRangeFilter;
|
|
12167
|
+
/** Filters the transactions based on the transaction’s date either by specifying a “from” and/or “to” date, or by using a `DateMacro`. */
|
|
12168
|
+
TransactionDateRangeFilter?: TransactionDateRangeFilter;
|
|
12169
|
+
/** Filters the transactions based on the `EntityRef` used in the transaction or transaction line by specifying an entity type filter, a `ListID`, a `FullName`, a `ListIDWithChildren`, or a `FullNameWithChildren`.
|
|
12170
|
+
|
|
12171
|
+
If you want to filter on transaction lines you must specify the `TransactionDetailLevelFilter` with a value of either “All” or “`AllExceptSummary`”. */
|
|
12172
|
+
TransactionEntityFilter?: TransactionEntityFilter;
|
|
12173
|
+
/** Filters the transactions based on the `AccountRef` in the transaction or transaction line using an account type filter or a specific `ListID`, or a `FullName`, or a `ListIDWithChildren`, or a `FullNameWithChildren`.
|
|
12174
|
+
|
|
12175
|
+
To filter on transaction lines, you must specify the `TransactionDetailLevelFilter` with a value of either “All” or “`AllExceptSummary`”. */
|
|
12176
|
+
TransactionAccountFilter?: TransactionAccountFilter;
|
|
12177
|
+
/** Filters the transactions based on the `ItemRef` used in the transaction line using an item type filter, or a specific `ListID`, or a `FullName`, or a `ListIDWithChildren`, or a `FullNameWithChildren`.
|
|
12178
|
+
|
|
12179
|
+
To filter on transaction lines, you must specify the `TransactionDetailLevelFilter` with a value of either “All” or “`AllExceptSummary`”. */
|
|
12180
|
+
TransactionItemFilter?: TransactionItemFilter;
|
|
12181
|
+
/** Filters the transactions based on the `ClassRef` in the transaction or transaction line by using a specific `ListID`, or a `FullName`, or a `ListIDWithChildren`, or a `FullNameWithChildren`.
|
|
12182
|
+
|
|
12183
|
+
To filter on transaction lines, you must specify the `TransactionDetailLevelFilter` with a value of either “All” or “`AllExceptSummary`”. */
|
|
12184
|
+
TransactionClassFilter?: TransactionClassFilter;
|
|
12185
|
+
/** Filters the transactions based on the transaction’s type. You can specify one or more transaction types in the filter. Notice that `TimeTracking` transactions are not supported.
|
|
12186
|
+
|
|
12187
|
+
If you set the transaction type filter to “All” (or if you don’t set it at all), the query will be searching only those transaction types that are permissible types for the user currently logged in. If instead of “all,” you specify a transaction type that the currently logged in user is not permitted to access, you will get a runtime error, even if other permissible transaction types were specified as well. */
|
|
12188
|
+
TransactionTypeFilter?: TransactionTypeFilter;
|
|
12189
|
+
/** Allows you to specify the detail level of the query results. You can specify all, summary only (the default), or all except summary. Summary only refers to the transaction as a whole, whereas all except summary refers to the transaction lines. */
|
|
12190
|
+
TransactionDetailLevelFilter?: TransactionDetailLevelFilter;
|
|
12191
|
+
/** Allows you to filter transactions based on posting status. Valid values are posting, non-posting, or either. The default is “either.” (Posting status refers to whether QuickBooks records a transaction in one of your account registers.) */
|
|
12192
|
+
TransactionPostingStatusFilter?: TransactionPostingStatusFilter;
|
|
12193
|
+
/** This filter allows you to search for “open” transactions, i.e. transactions with a remaining balance (for example, credits not fully applied or invoices not fully paid). Valid values are closed, open, or either, which is the default. */
|
|
12194
|
+
TransactionPaidStatusFilter?: TransactionPaidStatusFilter;
|
|
12195
|
+
/** Filters by the specified currency. */
|
|
12196
|
+
CurrencyFilter?: CurrencyFilter;
|
|
12197
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
12198
|
+
|
|
12199
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
|
|
12200
|
+
|
|
12201
|
+
Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
12202
|
+
IncludeRetElement?: string[] | string;
|
|
12203
|
+
}
|
|
12204
|
+
export interface TransactionQueryRs {
|
|
12205
|
+
TransactionRet: TransactionRet[];
|
|
12206
|
+
}
|
|
12207
|
+
export interface TransactionRet {
|
|
12208
|
+
/** The type of transaction. */
|
|
12209
|
+
TxnType?: TxnType;
|
|
12210
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.
|
|
12211
|
+
|
|
12212
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
12213
|
+
TxnID?: string;
|
|
12214
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
12215
|
+
|
|
12216
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
12217
|
+
TxnLineID?: string;
|
|
12218
|
+
/** Time the object was created. */
|
|
12219
|
+
TimeCreated?: string;
|
|
12220
|
+
/** Time the object was last modified. */
|
|
12221
|
+
TimeModified?: string;
|
|
12222
|
+
/** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list.
|
|
12223
|
+
|
|
12224
|
+
Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name. In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded. In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
|
|
12225
|
+
EntityRef?: EntityRef;
|
|
12226
|
+
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
12227
|
+
|
|
12228
|
+
Special cases to note: In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied. In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed.
|
|
12229
|
+
|
|
12230
|
+
How do you increase and decrease amounts in bank accounts?
|
|
12231
|
+
|
|
12232
|
+
The following requests increase the balance in a bank account:
|
|
12233
|
+
|
|
12234
|
+
Deposit Add
|
|
12235
|
+
|
|
12236
|
+
`ReceivePaymentAdd`
|
|
12237
|
+
|
|
12238
|
+
Journal Entry Add
|
|
12239
|
+
|
|
12240
|
+
Sales `ReceiptAdd`
|
|
12241
|
+
|
|
12242
|
+
The following requests decrease the balance in a bank account:
|
|
12243
|
+
|
|
12244
|
+
`CheckAdd`
|
|
12245
|
+
|
|
12246
|
+
Bill `PaymentCheckAdd`
|
|
12247
|
+
|
|
12248
|
+
`JournalEntryAdd` */
|
|
12249
|
+
AccountRef?: AccountRef;
|
|
12250
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
12251
|
+
TxnDate?: string;
|
|
12252
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
12253
|
+
|
|
12254
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
12255
|
+
|
|
12256
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
12257
|
+
RefNumber?: string;
|
|
12258
|
+
/** A monetary amount. */
|
|
12259
|
+
Amount?: string;
|
|
12260
|
+
/** The currency object contains all of the information needed by QuickBooks to display and use. For built-in currencies, the name and currency code values are internationally accepted values and thus are not editable. The comma format is editable, as is the `IsActive` status. For user-defined currencies, every value in the object is editable including name and currency code.
|
|
12261
|
+
|
|
12262
|
+
When used with `PriceLevels`, the `CurrencyRef` should only be used with “per item” price levels. */
|
|
12263
|
+
CurrencyRef?: CurrencyRef;
|
|
12264
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`.
|
|
12265
|
+
|
|
12266
|
+
You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
12267
|
+
ExchangeRate?: number;
|
|
12268
|
+
/** Amount in units of the home currency. */
|
|
12269
|
+
AmountInHomeCurrency?: string;
|
|
12270
|
+
/** Additional information. */
|
|
12271
|
+
Memo?: string;
|
|
12272
|
+
}
|
|
12273
|
+
export interface TransactionTypeFilter {
|
|
12274
|
+
/** A list of the transaction types you want the report to cover. */
|
|
12275
|
+
TxnTypeFilter: TxnTypeFilter | TxnTypeFilter[];
|
|
12276
|
+
}
|
|
12044
12277
|
export interface TransferAdd {
|
|
12045
12278
|
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
12046
12279
|
TxnDate?: string;
|