TransactionQuery(4.0)
TransactionQuery is a generic transaction query that provides functionality (e.g. filters) similar to the Advanced Find window in the QuickBooks UI. It allows you to search for transactions across different transaction types. In contrast to the other transaction-specific queries, the
TransactionQuery only returns data common to all transactions, such as TxnID, type, dates, accountRef, and so on. This query does return condensed transactions.
Accordingly, if additional and more transaction-specific data is required, a subsequent call to the desired query can be used to get that transaction-specific data. For example, the TransactionQuery can be used to present all transactions in a certain date range, then the user can select a
particular transaction, say an invoice transaction. In response to this choice, you could do an InvoiceQuery to pull up all of the invoice data, similar to QuickZoom in the QuickBooks UI.
Important
You should be aware that permissions are obeyed in this query. So, 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. Accordingly, 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.
Finally, the transaction query is subject to sensitive data access level restrictions and payroll subscription status.
Request
Response
XMLOps
VB.NET
C#
| Tag | Type | Max length | Implementation | Required |
|---|---|---|---|---|
ITransactionQuery
TransactionQuery is a generic transaction query that provides functionality (e.g. filters) similar to the Advanced Find window in the QuickBooks UI. It allows you to search for transactions across different transaction types. In contrast to the other transaction-specific queries, the TransactionQuery only returns data common to all transactions, such as TxnID, type, dates, accountRef, and so on. This query does return condensed transactions. Accordingly, if additional and more transaction-specific data is required, a subsequent call to the desired query can be used to get that transaction-specific data. For example, the TransactionQuery can be used to present all transactions in a certain date range, then the user can select a particular transaction, say an invoice transaction. In response to this choice, you could do an InvoiceQuery to pull up all of the invoice data, similar to QuickZoom in the QuickBooks UI. Important You should be aware that permissions are obeyed in this query. So, 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. Accordingly, 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. Finally, the transaction query is subject to sensitive data access level restrictions and payroll subscription status.
|
4.0 | |||
metaData
This is used in a query to cause a count of query objects to be returned. You can specify that the count of query objects is to be returned with the returned objects, or you can specify that only a count and no data is returned. (The default is that no count is returned.) A common use of this feature is to specify a count with no data in order to determine how many objects to expect from the actual query. If you don’t want a query to return a count, either don’t use this feature, or specify the value NoMetaData. If you want only a count, specify the value MetaDataOnly. If you want data and a count, specify MetaDataAndResponseData. You should be aware that the count returned via this setting is not guaranteed to be exact: it could be off slightly due to new object creation or deletions.
|
IQBENmetaDataType | 4.0  |
||
iterator
The iterator attribute provided with most query types also allows you to break down query results in smaller and more manageable chunks of data. An iterator results in responses that contain only the specified number of objects. Iterators are only valid for the application that starts them, and they are only valid for the current QuickBooks session.
|
IQBENiteratorType | 5.0 |
||
iteratorID
Returned in the response in the first iteration and supplied in subsequent iterations, this identifies which iteration is to be used in the query continuing the iteration. Required because many different iterations may be currently in use.
|
IQBUUIDType | 5.0 |
||
ORTransactionQuery |
IORTransactionQuery | |||
TxnIDList
One or more TxnID values. QuickBooks generates a unique TxnID for each transaction that is added to QuickBooks. 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.
|
IBSTRList | |||
TransactionFilter
The filter to be used in the transaction query. You can filter by refNumber, refNumber ranges, modified date, modified date ranges, transaction date, transaction date range, transaction account, transaction item, transaction class, transaction type, transaction detail level, transaction posting status, or transaction paid status.
|
ITransactionFilter | |||
MaxReturned
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.
|
IQBIntType | |||
ORTransactionRefNumberFilter |
IORTransactionRefNumberFilter | |||
RefNumberList
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. 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.
|
IBSTRList | |||
RefNumberCaseSensitiveList
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. 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.
|
IBSTRList | 4.0 | ||
RefNumberFilter
Filters according to RefNumber.
|
IRefNumberFilter | |||
MatchCriterion
The criterion to match.
|
IQBENMatchCriterionType | Y | ||
RefNumber
A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a BillPaymentCheckAdd request, if you want to set the check number, use RefNumber. 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.
|
IQBStringType | Y | ||
RefNumberRangeFilter
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.
|
IRefNumberRangeFilter | |||
FromRefNumber
The first RefNumber in the search range. If FromRefNumber is omitted, the range will begin with first number on the list.
|
IQBStringType | |||
ToRefNumber
The final RefNumber in the search range. If ToRefNumber is omitted, the range will end with last number on the list.
|
IQBStringType | |||
TransactionModifiedDateRangeFilter
Filters the transactions based on the transaction’s modified datetime, either by specifying a “from” and/or “to” date or by using a DateMacro.
|
ITransactionModifiedDateRangeFilter | |||
ORTransactionModifiedDateRangeFilter |
IORTransactionModifiedDateRangeFilter | Y | ||
ModifiedDateRange
Specifies the range of dates to be used in the transaction modified date range filter. You can specify a “from” and/or a “to” date. Notice that this applies only to modifications, not deletions. To get deleted transactions, use TxnDeletedQuery.
|
IModifiedDateRange | |||
FromModifiedDate
Selects objects modified on or after this date. See the note below regarding QBFC usage. 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). 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. 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).
|
IQBDateTimeType | |||
ToModifiedDate
Selects objects modified on or before this date. See the note below on QBFC usage. 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). 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. 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).
|
IQBDateTimeType | |||
DateMacro
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. DateMacro values, in alphabetical order, that are new with QBFC3: 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 The list given when you click IQBENDateMacroType shows the complete list of valid version 3.0 values.
|
IQBENDateMacroType | |||
TransactionDateRangeFilter
Filters the transactions based on the transaction’s date either by specifying a “from” and/or “to” date, or by using a DateMacro.
|
ITransactionDateRangeFilter | |||
ORTransactionDateRangeFilter |
IORTransactionDateRangeFilter | Y | ||
TxnDateRange
Specifies the range of dates to be used in the transaction date range filter. You can specify a “from” and/or a “to” date.
|
ITxnDateRange | |||
FromTxnDate
Selects transactions created on or after this date. Both FromTxnDate and ToTxnDate must be between 01/01/1901 and 12/31/9999. If you omit FromTxnDate, it will be set to 1970-01-01 (1969-12-31 PST).
|
IQBDateType | |||
ToTxnDate
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).
|
IQBDateType | |||
DateMacro
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. DateMacro values, in alphabetical order, that are new with QBFC3: 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 The list given when you click IQBENDateMacroType shows the complete list of valid version 3.0 values.
|
IQBENDateMacroType | |||
TransactionEntityFilter
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. If you want to filter on transaction lines you must specify the TransactionDetailLevelFilter with a value of either “All” or “AllExceptSummary”.
|
ITransactionEntityFilter | |||
ORTransactionEntityFilter |
IORTransactionEntityFilter | Y | ||
EntityTypeFilter
Allows you to report on a specific name type.
|
IQBENEntityTypeFilterType | |||
ListIDList
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. 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.
|
IBSTRList | |||
FullNameList
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.
|
IBSTRList | |||
ListIDWithChildren
Allows you to filter for data that relates to the specified object and its descendants.
|
IQBIDType | |||
FullNameWithChildren
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.
|
IQBStringType | |||
TransactionAccountFilter
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. To filter on transaction lines, you must specify the TransactionDetailLevelFilter with a value of either “All” or “AllExceptSummary”.
|
ITransactionAccountFilter | |||
ORTransactionAccountFilter |
IORTransactionAccountFilter | Y | ||
AccountTypeFilter
Allows you to report on a specific account type.
|
IQBENAccountTypeFilterType | |||
ListIDList
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. 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.
|
IBSTRList | |||
FullNameList
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.
|
IBSTRList | |||
ListIDWithChildren
Allows you to filter for data that relates to the specified object and its descendants.
|
IQBIDType | |||
FullNameWithChildren
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.
|
IQBStringType | |||
TransactionItemFilter
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. To filter on transaction lines, you must specify the TransactionDetailLevelFilter with a value of either “All” or “AllExceptSummary”.
|
ITransactionItemFilter | |||
ORTransactionItemFilter |
IORTransactionItemFilter | Y | ||
ItemTypeFilter
Allows you to report on a specific item type.
|
IQBENItemTypeFilterType | |||
ListIDList
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. 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.
|
IBSTRList | |||
FullNameList
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.
|
IBSTRList | |||
ListIDWithChildren
Allows you to filter for data that relates to the specified object and its descendants.
|
IQBIDType | |||
FullNameWithChildren
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.
|
IQBStringType | |||
TransactionClassFilter
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. To filter on transaction lines, you must specify the TransactionDetailLevelFilter with a value of either “All” or “AllExceptSummary”.
|
ITransactionClassFilter | |||
ORTransactionClassFilter |
IORTransactionClassFilter | Y | ||
ListIDList
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. 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.
|
IBSTRList | |||
FullNameList
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.
|
IBSTRList | |||
ListIDWithChildren
Allows you to filter for data that relates to the specified object and its descendants.
|
IQBIDType | |||
FullNameWithChildren
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.
|
IQBStringType | |||
TransactionTypeFilter
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. 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.
|
ITransactionTypeFilter | |||
TxnTypeFilterList
A list of the transaction types you want the report to cover.
|
IENTxnTypeFilterList | Y | ||
TransactionDetailLevelFilter
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.
|
IQBENTransactionDetailLevelFilterType | |||
TransactionPostingStatusFilter
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.)
|
IQBENTransactionPostingStatusFilterType | |||
TransactionPaidStatusFilter
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.
|
IQBENTransactionPaidStatusFilterType | |||
CurrencyFilter
Filters by the specified currency.
|
ICurrencyFilter | 8.0 | ||
ORCurrencyFilter |
IORCurrencyFilter | Y | ||
ListIDList
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. 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.
|
IBSTRList | |||
FullNameList
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.
|
IBSTRList | 64 chars | ||
IncludeRetElementList
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. 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. 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.
|
IBSTRList | 50 chars |
| Tag | Type | Max length | Implementation | Required |
|---|---|---|---|---|
IResponse
TransactionQuery is a generic transaction query that provides functionality (e.g. filters) similar to the Advanced Find window in the QuickBooks UI. It allows you to search for transactions across different transaction types. In contrast to the other transaction-specific queries, the TransactionQuery only returns data common to all transactions, such as TxnID, type, dates, accountRef, and so on. This query does return condensed transactions. Accordingly, if additional and more transaction-specific data is required, a subsequent call to the desired query can be used to get that transaction-specific data. For example, the TransactionQuery can be used to present all transactions in a certain date range, then the user can select a particular transaction, say an invoice transaction. In response to this choice, you could do an InvoiceQuery to pull up all of the invoice data, similar to QuickZoom in the QuickBooks UI. Important You should be aware that permissions are obeyed in this query. So, 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. Accordingly, 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. Finally, the transaction query is subject to sensitive data access level restrictions and payroll subscription status.
|
4.0 | |||
StatusCode
A number that corresponds to a statusSeverity and statusMessage. Five status codes relate directly to signon messages: 2000, 2010, 2020, 2030, and 2040. For details about these and other statusCode values that can be returned, see the statusCode table on the Error Codes page.
|
IQBIntType | Y | ||
StatusSeverity
One of the following values: INFO The request was completed, and the results are consistent with what your application expected. WARNING The request was completed, but the results might not be consistent with what you expected. ERROR The request was not completed. No data will appear in the server’s response after the statusMessage.
|
IQBStringType | Y | ||
StatusMessage
A user-readable explanation of the success or error condition that is indicated by the statusCode. For details about the statusMessage values that can be returned, see the “Explanation” column of the statusCode table on the Error Codes page.
|
IQBStringType | Y | ||
retCount
The retCount is returned in a query if in the query request you specified the metaData attribute with a value of MetaDataOnly (in which case the retCount is the only data returned in the query response) or MetaDataAndResponseData (the query response contains object data AND the approximate count). The retCount value contains the approximate count of the objects that could be expected to be returned from the query. A common use of this feature is to specify a count with no data in order to determine how many objects to expect from the actual query. You should be aware that the count returned in retCount is not guaranteed to be exact: it could be off slightly due to new object creation or deletions.
|
IQBIntType | 4.0 |
Y | |
iteratorRemainingCount
This attribute is provided in the response in a query using iterators, indicating the number of objects remaining in the iteration. This can help you specify a MaxReturn value tailored to the number of objects still to be iterated through in your query.
|
IQBIntType | 5.0 |
Y | |
iteratorID
Returned in the response in the first iteration and supplied in subsequent iterations, this identifies which iteration is to be used in the query continuing the iteration. Required because many different iterations may be currently in use.
|
IQBUUIDType | 5.0 |
Y | |
Detail |
ITransactionRetList | |||
(List
of ITransactionRet Objects)
|
||||
TxnType
The type of transaction.
|
IQBENTxnTypeType | |||
TxnID
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. 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.
|
IQBIDType | |||
TxnLineID
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.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the TxnLineID to -1.
|
IQBIDType | |||
TimeCreated
Time the object was created.
|
IQBDateTimeType | |||
TimeModified
Time the object was last modified.
|
IQBDateTimeType | |||
EntityRef
A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. 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.
|
IQBBaseRef | |||
ListID
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. 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.
|
IQBIDType | |||
FullName
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.
|
IQBStringType | 209 chars | ||
AccountRef
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.) 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. How do you increase and decrease amounts in bank accounts? The following requests increase the balance in a bank account: Deposit Add ReceivePaymentAdd Journal Entry Add Sales ReceiptAdd The following requests decrease the balance in a bank account: CheckAdd Bill PaymentCheckAdd JournalEntryAdd
|
IQBBaseRef | |||
ListID
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. 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.
|
IQBIDType | |||
FullName
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.
|
IQBStringType | 159 chars | ||
TxnDate
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.
|
IQBDateType | |||
RefNumber
A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a BillPaymentCheckAdd request, if you want to set the check number, use RefNumber. 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.
|
IQBStringType | |||
Amount
A monetary amount.
|
IQBAmountType | |||
CurrencyRef
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. When used with PriceLevels, the CurrencyRef should only be used with “per item” price levels.
|
IQBBaseRef | 8.0 | ||
ListID
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. 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.
|
IQBIDType | 8.0 | ||
FullName
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.
|
IQBStringType | 64 chars | 8.0 | |
ExchangeRate
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. 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.)
|
IQBFloatType | 8.0 | ||
AmountInHomeCurrency
Amount in units of the home currency.
|
IQBAmountType | 8.0 | ||
Memo
Additional information.
|
IQBStringType | 4095 chars |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <TransactionQueryRq metaData="ENUMTYPE" iterator="ENUMTYPE" iteratorID="UUIDTYPE"> <!-- BEGIN OR --> <TxnID >IDTYPE</TxnID> <!-- optional, may repeat --> <!-- OR --> <MaxReturned >INTTYPE</MaxReturned> <!-- optional --> <!-- BEGIN OR --> <RefNumber >STRTYPE</RefNumber> <!-- optional, may repeat --> <!-- OR --> <RefNumberCaseSensitive >STRTYPE</RefNumberCaseSensitive> <!-- optional, may repeat --> <!-- OR --> <RefNumberFilter> <!-- optional --> <!-- MatchCriterion may have one of the following values: StartsWith, Contains, EndsWith --> <MatchCriterion >ENUMTYPE</MatchCriterion> <!-- required --> <RefNumber >STRTYPE</RefNumber> <!-- required --> </RefNumberFilter> <!-- OR --> <RefNumberRangeFilter> <!-- optional --> <FromRefNumber >STRTYPE</FromRefNumber> <!-- optional --> <ToRefNumber >STRTYPE</ToRefNumber> <!-- optional --> </RefNumberRangeFilter> <!-- END OR --> <TransactionModifiedDateRangeFilter> <!-- optional --> <!-- BEGIN OR --> <FromModifiedDate >DATETIMETYPE</FromModifiedDate> <!-- optional --> <ToModifiedDate >DATETIMETYPE</ToModifiedDate> <!-- optional --> <!-- OR --> <!-- DateMacro may have one of the following values: All, Today, ThisWeek, ThisWeekToDate, ThisMonth, ThisMonthToDate, ThisCalendarQuarter, ThisCalendarQuarterToDate, ThisFiscalQuarter, ThisFiscalQuarterToDate, ThisCalendarYear, ThisCalendarYearToDate, ThisFiscalYear, ThisFiscalYearToDate, Yesterday, LastWeek, LastWeekToDate, LastMonth, LastMonthToDate, LastCalendarQuarter, LastCalendarQuarterToDate, LastFiscalQuarter, LastFiscalQuarterToDate, LastCalendarYear, LastCalendarYearToDate, LastFiscalYear, LastFiscalYearToDate, NextWeek, NextFourWeeks, NextMonth, NextCalendarQuarter, NextCalendarYear, NextFiscalQuarter, NextFiscalYear --> <DateMacro >ENUMTYPE</DateMacro> <!-- optional --> <!-- END OR --> </TransactionModifiedDateRangeFilter> <TransactionDateRangeFilter> <!-- optional --> <!-- BEGIN OR --> <FromTxnDate >DATETYPE</FromTxnDate> <!-- optional --> <ToTxnDate >DATETYPE</ToTxnDate> <!-- optional --> <!-- OR --> <!-- DateMacro may have one of the following values: All, Today, ThisWeek, ThisWeekToDate, ThisMonth, ThisMonthToDate, ThisCalendarQuarter, ThisCalendarQuarterToDate, ThisFiscalQuarter, ThisFiscalQuarterToDate, ThisCalendarYear, ThisCalendarYearToDate, ThisFiscalYear, ThisFiscalYearToDate, Yesterday, LastWeek, LastWeekToDate, LastMonth, LastMonthToDate, LastCalendarQuarter, LastCalendarQuarterToDate, LastFiscalQuarter, LastFiscalQuarterToDate, LastCalendarYear, LastCalendarYearToDate, LastFiscalYear, LastFiscalYearToDate, NextWeek, NextFourWeeks, NextMonth, NextCalendarQuarter, NextCalendarYear, NextFiscalQuarter, NextFiscalYear --> <DateMacro >ENUMTYPE</DateMacro> <!-- optional --> <!-- END OR --> </TransactionDateRangeFilter> <TransactionEntityFilter> <!-- optional --> <!-- BEGIN OR --> <!-- EntityTypeFilter may have one of the following values: Customer, Employee, OtherName, Vendor --> <EntityTypeFilter >ENUMTYPE</EntityTypeFilter> <!-- optional --> <!-- OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- OR --> <ListIDWithChildren >IDTYPE</ListIDWithChildren> <!-- optional --> <!-- OR --> <FullNameWithChildren >STRTYPE</FullNameWithChildren> <!-- optional --> <!-- END OR --> </TransactionEntityFilter> <TransactionAccountFilter> <!-- optional --> <!-- BEGIN OR --> <!-- AccountTypeFilter may have one of the following values: AccountsPayable, AccountsReceivable, AllowedFor1099, APAndSalesTax, APOrCreditCard, ARAndAP, Asset, BalanceSheet, Bank, BankAndARAndAPAndUF, BankAndUF, CostOfSales, CreditCard, CurrentAsset, CurrentAssetAndExpense, CurrentLiability, Equity, EquityAndIncomeAndExpense, ExpenseAndOtherExpense, FixedAsset, IncomeAndExpense, IncomeAndOtherIncome, Liability, LiabilityAndEquity, LongTermLiability, NonPosting, OrdinaryExpense, OrdinaryIncome, OrdinaryIncomeAndCOGS, OrdinaryIncomeAndExpense, OtherAsset, OtherCurrentAsset, OtherCurrentLiability, OtherExpense, OtherIncome, OtherIncomeOrExpense --> <AccountTypeFilter >ENUMTYPE</AccountTypeFilter> <!-- optional --> <!-- OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- OR --> <ListIDWithChildren >IDTYPE</ListIDWithChildren> <!-- optional --> <!-- OR --> <FullNameWithChildren >STRTYPE</FullNameWithChildren> <!-- optional --> <!-- END OR --> </TransactionAccountFilter> <TransactionItemFilter> <!-- optional --> <!-- BEGIN OR --> <!-- ItemTypeFilter may have one of the following values: AllExceptFixedAsset, Assembly, Discount, FixedAsset, Inventory, InventoryAndAssembly, NonInventory, OtherCharge, Payment, Sales, SalesTax, Service --> <ItemTypeFilter >ENUMTYPE</ItemTypeFilter> <!-- optional --> <!-- OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- OR --> <ListIDWithChildren >IDTYPE</ListIDWithChildren> <!-- optional --> <!-- OR --> <FullNameWithChildren >STRTYPE</FullNameWithChildren> <!-- optional --> <!-- END OR --> </TransactionItemFilter> <TransactionClassFilter> <!-- optional --> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- OR --> <ListIDWithChildren >IDTYPE</ListIDWithChildren> <!-- optional --> <!-- OR --> <FullNameWithChildren >STRTYPE</FullNameWithChildren> <!-- optional --> <!-- END OR --> </TransactionClassFilter> <TransactionTypeFilter> <!-- optional --> <!-- TxnTypeFilter may have one of the following values: All, ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, BuildAssembly, Charge, Check, CreditCardCharge, CreditCardCredit, CreditMemo, Deposit, Estimate, InventoryAdjustment, Invoice, ItemReceipt, JournalEntry, LiabilityAdjustment, Paycheck, PayrollLiabilityCheck, PurchaseOrder, ReceivePayment, SalesOrder, SalesReceipt, SalesTaxPaymentCheck, Transfer, VendorCredit, YTDAdjustment --> <TxnTypeFilter >ENUMTYPE</TxnTypeFilter> <!-- required, may repeat --> </TransactionTypeFilter> <!-- TransactionDetailLevelFilter may have one of the following values: All, SummaryOnly [DEFAULT], AllExceptSummary --> <TransactionDetailLevelFilter >ENUMTYPE</TransactionDetailLevelFilter> <!-- optional --> <!-- TransactionPostingStatusFilter may have one of the following values: Either [DEFAULT], NonPosting, Posting --> <TransactionPostingStatusFilter >ENUMTYPE</TransactionPostingStatusFilter> <!-- optional --> <!-- TransactionPaidStatusFilter may have one of the following values: Either [DEFAULT], Closed, Open --> <TransactionPaidStatusFilter >ENUMTYPE</TransactionPaidStatusFilter> <!-- optional --> <CurrencyFilter> <!-- optional --> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- END OR --> </CurrencyFilter> <!-- END OR --> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </TransactionQueryRq> <TransactionQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE" iteratorRemainingCount="INTTYPE" iteratorID="UUIDTYPE"> <TransactionRet> <!-- optional, may repeat --> <!-- TxnType may have one of the following values: ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, BuildAssembly, Charge, Check, CreditCardCharge, CreditCardCredit, CreditMemo, Deposit, Estimate, InventoryAdjustment, Invoice, ItemReceipt, JournalEntry, LiabilityAdjustment, Paycheck, PayrollLiabilityCheck, PurchaseOrder, ReceivePayment, SalesOrder, SalesReceipt, SalesTaxPaymentCheck, Transfer, VendorCredit, YTDAdjustment --> <TxnType >ENUMTYPE</TxnType> <!-- optional --> <TxnID >IDTYPE</TxnID> <!-- optional --> <TxnLineID >IDTYPE</TxnLineID> <!-- optional --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional --> <TimeModified >DATETIMETYPE</TimeModified> <!-- optional --> <EntityRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </EntityRef> <AccountRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </AccountRef> <TxnDate >DATETYPE</TxnDate> <!-- optional --> <RefNumber >STRTYPE</RefNumber> <!-- optional --> <Amount >AMTTYPE</Amount> <!-- optional --> <CurrencyRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </CurrencyRef> <ExchangeRate >FLOATTYPE</ExchangeRate> <!-- optional --> <AmountInHomeCurrency >AMTTYPE</AmountInHomeCurrency> <!-- optional --> <Memo >STRTYPE</Memo> <!-- optional --> </TransactionRet> </TransactionQueryRs> </QBXMLMsgsRq> </QBXML> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 | 'The following sample code is generated as an illustration of
'Creating requests and parsing responses ONLY
'This code is NOT intended to show best practices or ideal code
'Use at your most careful discretion
imports System
imports System.Net
imports System.Drawing
imports System.Collections
imports System.ComponentModel
imports System.Windows.Forms
imports System.Data
imports System.IO
imports Interop.QBFC16
Module com.intuit.idn.samples
Public Class Sample
Public Sub DoTransactionQuery()
Dim sessionBegun as Boolean
sessionBegun = False
Dim connectionOpen as Boolean
connectionOpen = False
Dim sessionManager as QBSessionManager
sessionManager = nothing
Try
'Create the session Manager object
sessionManager = new QBSessionManager
'Create the message set request object to hold our request
Dim requestMsgSet as IMsgSetRequest
requestMsgSet = sessionManager.CreateMsgSetRequest("US",16,0)
requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue
BuildTransactionQueryRq(requestMsgSet)
'Connect to QuickBooks and begin a session
sessionManager.OpenConnection("","Sample Code from OSR")
connectionOpen = True
sessionManager.BeginSession("", ENOpenMode.omDontCare)
sessionBegun = True
'Send the request and get the response from QuickBooks
Dim responseMsgSet as IMsgSetResponse
responseMsgSet = sessionManager.DoRequests(requestMsgSet)
'End the session and close the connection to QuickBooks
sessionManager.EndSession()
sessionBegun = False
sessionManager.CloseConnection()
connectionOpen = False
WalkTransactionQueryRs(responseMsgSet)
Catch e as Exception
MessageBox.Show(e.Message, "Error")
if (sessionBegun) then
sessionManager.EndSession()
End If
if (connectionOpen) then
sessionManager.CloseConnection()
End If
End Try
End Sub
Public Sub BuildTransactionQueryRq(requestMsgSet as IMsgSetRequest)
Dim TransactionQueryRq as ITransactionQuery
TransactionQueryRq= requestMsgSet.AppendTransactionQueryRq()
Dim ORTransactionQueryElementType22579 as String
ORTransactionQueryElementType22579 = "TxnIDList"
if (ORTransactionQueryElementType22579 == "TxnIDList") then
'Set field value for TxnIDList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TxnIDList.Add("200000-1011023419")
End If
if (ORTransactionQueryElementType22579 == "TransactionFilter") then
'Set field value for MaxReturned
TransactionQueryRq.ORTransactionQuery.TransactionFilter.MaxReturned.SetValue(6)
Dim ORTransactionRefNumberFilterElementType22580 as String
ORTransactionRefNumberFilterElementType22580 = "RefNumberList"
if (ORTransactionRefNumberFilterElementType22580 == "RefNumberList") then
'Set field value for RefNumberList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberList.Add("ab")
End If
if (ORTransactionRefNumberFilterElementType22580 == "RefNumberCaseSensitiveList") then
'Set field value for RefNumberCaseSensitiveList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberCaseSensitiveList.Add("ab")
End If
if (ORTransactionRefNumberFilterElementType22580 == "RefNumberFilter") then
'Set field value for MatchCriterion
TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
'Set field value for RefNumber
TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberFilter.RefNumber.SetValue("ab")
End If
if (ORTransactionRefNumberFilterElementType22580 == "RefNumberRangeFilter") then
'Set field value for FromRefNumber
TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberRangeFilter.FromRefNumber.SetValue("ab")
'Set field value for ToRefNumber
TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberRangeFilter.ToRefNumber.SetValue("ab")
End If
Dim ORTransactionModifiedDateRangeFilterElementType22581 as String
ORTransactionModifiedDateRangeFilterElementType22581 = "ModifiedDateRange"
if (ORTransactionModifiedDateRangeFilterElementType22581 == "ModifiedDateRange") then
'Set field value for FromModifiedDate
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionModifiedDateRangeFilter.ORTransactionModifiedDateRangeFilter.ModifiedDateRange.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
'Set field value for ToModifiedDate
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionModifiedDateRangeFilter.ORTransactionModifiedDateRangeFilter.ModifiedDateRange.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
End If
if (ORTransactionModifiedDateRangeFilterElementType22581 == "DateMacro") then
'Set field value for DateMacro
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionModifiedDateRangeFilter.ORTransactionModifiedDateRangeFilter.DateMacro.SetValue(ENDateMacro.dmAll)
End If
Dim ORTransactionDateRangeFilterElementType22582 as String
ORTransactionDateRangeFilterElementType22582 = "TxnDateRange"
if (ORTransactionDateRangeFilterElementType22582 == "TxnDateRange") then
'Set field value for FromTxnDate
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDateRangeFilter.ORTransactionDateRangeFilter.TxnDateRange.FromTxnDate.SetValue(DateTime.Parse("12/15/2007"))
'Set field value for ToTxnDate
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDateRangeFilter.ORTransactionDateRangeFilter.TxnDateRange.ToTxnDate.SetValue(DateTime.Parse("12/15/2007"))
End If
if (ORTransactionDateRangeFilterElementType22582 == "DateMacro") then
'Set field value for DateMacro
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDateRangeFilter.ORTransactionDateRangeFilter.DateMacro.SetValue(ENDateMacro.dmAll)
End If
Dim ORTransactionEntityFilterElementType22583 as String
ORTransactionEntityFilterElementType22583 = "EntityTypeFilter"
if (ORTransactionEntityFilterElementType22583 == "EntityTypeFilter") then
'Set field value for EntityTypeFilter
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.EntityTypeFilter.SetValue(ENEntityTypeFilter.etfCustomer)
End If
if (ORTransactionEntityFilterElementType22583 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.ListIDList.Add("200000-1011023419")
End If
if (ORTransactionEntityFilterElementType22583 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.FullNameList.Add("ab")
End If
if (ORTransactionEntityFilterElementType22583 == "ListIDWithChildren") then
'Set field value for ListIDWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.ListIDWithChildren.SetValue("200000-1011023419")
End If
if (ORTransactionEntityFilterElementType22583 == "FullNameWithChildren") then
'Set field value for FullNameWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.FullNameWithChildren.SetValue("ab")
End If
Dim ORTransactionAccountFilterElementType22584 as String
ORTransactionAccountFilterElementType22584 = "AccountTypeFilter"
if (ORTransactionAccountFilterElementType22584 == "AccountTypeFilter") then
'Set field value for AccountTypeFilter
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.AccountTypeFilter.SetValue(ENAccountTypeFilter.atfAccountsPayable)
End If
if (ORTransactionAccountFilterElementType22584 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.ListIDList.Add("200000-1011023419")
End If
if (ORTransactionAccountFilterElementType22584 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.FullNameList.Add("ab")
End If
if (ORTransactionAccountFilterElementType22584 == "ListIDWithChildren") then
'Set field value for ListIDWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.ListIDWithChildren.SetValue("200000-1011023419")
End If
if (ORTransactionAccountFilterElementType22584 == "FullNameWithChildren") then
'Set field value for FullNameWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.FullNameWithChildren.SetValue("ab")
End If
Dim ORTransactionItemFilterElementType22585 as String
ORTransactionItemFilterElementType22585 = "ItemTypeFilter"
if (ORTransactionItemFilterElementType22585 == "ItemTypeFilter") then
'Set field value for ItemTypeFilter
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.ItemTypeFilter.SetValue(ENItemTypeFilter.itfAllExceptFixedAsset)
End If
if (ORTransactionItemFilterElementType22585 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.ListIDList.Add("200000-1011023419")
End If
if (ORTransactionItemFilterElementType22585 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.FullNameList.Add("ab")
End If
if (ORTransactionItemFilterElementType22585 == "ListIDWithChildren") then
'Set field value for ListIDWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.ListIDWithChildren.SetValue("200000-1011023419")
End If
if (ORTransactionItemFilterElementType22585 == "FullNameWithChildren") then
'Set field value for FullNameWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.FullNameWithChildren.SetValue("ab")
End If
Dim ORTransactionClassFilterElementType22586 as String
ORTransactionClassFilterElementType22586 = "ListIDList"
if (ORTransactionClassFilterElementType22586 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.ListIDList.Add("200000-1011023419")
End If
if (ORTransactionClassFilterElementType22586 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.FullNameList.Add("ab")
End If
if (ORTransactionClassFilterElementType22586 == "ListIDWithChildren") then
'Set field value for ListIDWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.ListIDWithChildren.SetValue("200000-1011023419")
End If
if (ORTransactionClassFilterElementType22586 == "FullNameWithChildren") then
'Set field value for FullNameWithChildren
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.FullNameWithChildren.SetValue("ab")
End If
'Set field value for TxnTypeFilterList
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionTypeFilter.TxnTypeFilterList.SetValue(ENTxnTypeFilterList.ttflAll)
'Set field value for TransactionDetailLevelFilter
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDetailLevelFilter.SetValue(ENTransactionDetailLevelFilter.tdlfAll)
'Set field value for TransactionPostingStatusFilter
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionPostingStatusFilter.SetValue(ENTransactionPostingStatusFilter.tpsfEither [DEFAULT])
'Set field value for TransactionPaidStatusFilter
TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionPaidStatusFilter.SetValue(ENTransactionPaidStatusFilter.tpsffEither [DEFAULT])
Dim ORCurrencyFilterElementType22587 as String
ORCurrencyFilterElementType22587 = "ListIDList"
if (ORCurrencyFilterElementType22587 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.CurrencyFilter.ORCurrencyFilter.ListIDList.Add("200000-1011023419")
End If
if (ORCurrencyFilterElementType22587 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
TransactionQueryRq.ORTransactionQuery.TransactionFilter.CurrencyFilter.ORCurrencyFilter.FullNameList.Add("ab")
End If
End If
'Set field value for IncludeRetElementList
'May create more than one of these if needed
TransactionQueryRq.IncludeRetElementList.Add("ab")
End Sub
Public Sub WalkTransactionQueryRs( responseMsgSet as IMsgSetResponse)
if (responseMsgSet is nothing) then
Exit Sub
End If
Dim responseList as IResponseList
responseList = responseMsgSet.ResponseList
if (responseList is nothing) then
Exit Sub
End If
'if we sent only one request, there is only one response, we'll walk the list for this sample
for j=0 to responseList.Count-1
Dim response as IResponse
response = responseList.GetAt(j)
'check the status code of the response, 0=ok, >0 is warning
if (response.StatusCode >= 0) then
'the request-specific response is in the details, make sure we have some
if (not response.Detail is nothing) then
'make sure the response is the type we're expecting
Dim responseType as ENResponseType
responseType = CType(response.Type.GetValue(),ENResponseType)
if (responseType == ENResponseType.rtTransactionQueryRs) then
'upcast to more specific type here, this is safe because we checked with response.Type check above
Dim TransactionRet as ITransactionRetList
TransactionRet = CType(response.Detail,ITransactionRetList)
WalkTransactionRet(TransactionRet)
End If
End If
End If
Next j
End Sub
Public Sub WalkTransactionRet(TransactionRet as ITransactionRetList)
if (TransactionRet is nothing) then
Exit Sub
End If
'Go through all the elements of ITransactionRetList
'Get value of TxnType
if ( not TransactionRet.TxnType is nothing) then
Dim TxnType22588 as ENTxnType
TxnType22588 = TransactionRet.TxnType.GetValue()
End If
'Get value of TxnID
if ( not TransactionRet.TxnID is nothing) then
Dim TxnID22589 as String
TxnID22589 = TransactionRet.TxnID.GetValue()
End If
'Get value of TxnLineID
if ( not TransactionRet.TxnLineID is nothing) then
Dim TxnLineID22590 as String
TxnLineID22590 = TransactionRet.TxnLineID.GetValue()
End If
'Get value of TimeCreated
if ( not TransactionRet.TimeCreated is nothing) then
Dim TimeCreated22591 as DateTime
TimeCreated22591 = TransactionRet.TimeCreated.GetValue()
End If
'Get value of TimeModified
if ( not TransactionRet.TimeModified is nothing) then
Dim TimeModified22592 as DateTime
TimeModified22592 = TransactionRet.TimeModified.GetValue()
End If
if (not TransactionRet.EntityRef. is nothing) then
'Get value of ListID
if ( not TransactionRet.EntityRef.ListID is nothing) then
Dim ListID22593 as String
ListID22593 = TransactionRet.EntityRef.ListID.GetValue()
End If
'Get value of FullName
if ( not TransactionRet.EntityRef.FullName is nothing) then
Dim FullName22594 as String
FullName22594 = TransactionRet.EntityRef.FullName.GetValue()
End If
End If
if (not TransactionRet.AccountRef. is nothing) then
'Get value of ListID
if ( not TransactionRet.AccountRef.ListID is nothing) then
Dim ListID22595 as String
ListID22595 = TransactionRet.AccountRef.ListID.GetValue()
End If
'Get value of FullName
if ( not TransactionRet.AccountRef.FullName is nothing) then
Dim FullName22596 as String
FullName22596 = TransactionRet.AccountRef.FullName.GetValue()
End If
End If
'Get value of TxnDate
if ( not TransactionRet.TxnDate is nothing) then
Dim TxnDate22597 as DateTime
TxnDate22597 = TransactionRet.TxnDate.GetValue()
End If
'Get value of RefNumber
if ( not TransactionRet.RefNumber is nothing) then
Dim RefNumber22598 as String
RefNumber22598 = TransactionRet.RefNumber.GetValue()
End If
'Get value of Amount
if ( not TransactionRet.Amount is nothing) then
Dim Amount22599 as Double
Amount22599 = TransactionRet.Amount.GetValue()
End If
if (not TransactionRet.CurrencyRef. is nothing) then
'Get value of ListID
if ( not TransactionRet.CurrencyRef.ListID is nothing) then
Dim ListID22600 as String
ListID22600 = TransactionRet.CurrencyRef.ListID.GetValue()
End If
'Get value of FullName
if ( not TransactionRet.CurrencyRef.FullName is nothing) then
Dim FullName22601 as String
FullName22601 = TransactionRet.CurrencyRef.FullName.GetValue()
End If
End If
'Get value of ExchangeRate
if ( not TransactionRet.ExchangeRate is nothing) then
Dim ExchangeRate22602 as IQBFloatType
ExchangeRate22602 = TransactionRet.ExchangeRate.GetValue()
End If
'Get value of AmountInHomeCurrency
if ( not TransactionRet.AmountInHomeCurrency is nothing) then
Dim AmountInHomeCurrency22603 as Double
AmountInHomeCurrency22603 = TransactionRet.AmountInHomeCurrency.GetValue()
End If
'Get value of Memo
if ( not TransactionRet.Memo is nothing) then
Dim Memo22604 as String
Memo22604 = TransactionRet.Memo.GetValue()
End If
End Sub
End Class
End Module
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 | //The following sample code is generated as an illustration of //Creating requests and parsing responses ONLY //This code is NOT intended to show best practices or ideal code //Use at your most careful discretion using System; using System.Net; using System.Drawing; using System.Collections; using System.ComponentModel; using System.Windows.Forms; using System.Data; using System.IO; using Interop.QBFC16; namespace com.intuit.idn.samples { public class Sample { public void DoTransactionQuery() { bool sessionBegun = false; bool connectionOpen = false; QBSessionManager sessionManager = null; try { //Create the session Manager object sessionManager = new QBSessionManager(); //Create the message set request object to hold our request IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest("US",16,0); requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue; BuildTransactionQueryRq(requestMsgSet); //Connect to QuickBooks and begin a session sessionManager.OpenConnection("","Sample Code from OSR"); connectionOpen = true; sessionManager.BeginSession("", ENOpenMode.omDontCare); sessionBegun = true; //Send the request and get the response from QuickBooks IMsgSetResponse responseMsgSet = sessionManager.DoRequests(requestMsgSet); //End the session and close the connection to QuickBooks sessionManager.EndSession(); sessionBegun = false; sessionManager.CloseConnection(); connectionOpen = false; WalkTransactionQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildTransactionQueryRq(IMsgSetRequest requestMsgSet) { ITransactionQuery TransactionQueryRq= requestMsgSet.AppendTransactionQueryRq(); //Set attributes //Set field value for metaData TransactionQueryRq.metaData.SetValue("IQBENmetaDataType"); //Set field value for iterator TransactionQueryRq.iterator.SetValue("IQBENiteratorType"); //Set field value for iteratorID TransactionQueryRq.iteratorID.SetValue("IQBUUIDType"); string ORTransactionQueryElementType22553 = "TxnIDList"; if (ORTransactionQueryElementType22553 == "TxnIDList") { //Set field value for TxnIDList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TxnIDList.Add("200000-1011023419"); } if (ORTransactionQueryElementType22553 == "TransactionFilter") { //Set field value for MaxReturned TransactionQueryRq.ORTransactionQuery.TransactionFilter.MaxReturned.SetValue(6); string ORTransactionRefNumberFilterElementType22554 = "RefNumberList"; if (ORTransactionRefNumberFilterElementType22554 == "RefNumberList") { //Set field value for RefNumberList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberList.Add("ab"); } if (ORTransactionRefNumberFilterElementType22554 == "RefNumberCaseSensitiveList") { //Set field value for RefNumberCaseSensitiveList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberCaseSensitiveList.Add("ab"); } if (ORTransactionRefNumberFilterElementType22554 == "RefNumberFilter") { //Set field value for MatchCriterion TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for RefNumber TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberFilter.RefNumber.SetValue("ab"); } if (ORTransactionRefNumberFilterElementType22554 == "RefNumberRangeFilter") { //Set field value for FromRefNumber TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberRangeFilter.FromRefNumber.SetValue("ab"); //Set field value for ToRefNumber TransactionQueryRq.ORTransactionQuery.TransactionFilter.ORTransactionRefNumberFilter.RefNumberRangeFilter.ToRefNumber.SetValue("ab"); } string ORTransactionModifiedDateRangeFilterElementType22555 = "ModifiedDateRange"; if (ORTransactionModifiedDateRangeFilterElementType22555 == "ModifiedDateRange") { //Set field value for FromModifiedDate TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionModifiedDateRangeFilter.ORTransactionModifiedDateRangeFilter.ModifiedDateRange.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionModifiedDateRangeFilter.ORTransactionModifiedDateRangeFilter.ModifiedDateRange.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); } if (ORTransactionModifiedDateRangeFilterElementType22555 == "DateMacro") { //Set field value for DateMacro TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionModifiedDateRangeFilter.ORTransactionModifiedDateRangeFilter.DateMacro.SetValue(ENDateMacro.dmAll); } string ORTransactionDateRangeFilterElementType22556 = "TxnDateRange"; if (ORTransactionDateRangeFilterElementType22556 == "TxnDateRange") { //Set field value for FromTxnDate TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDateRangeFilter.ORTransactionDateRangeFilter.TxnDateRange.FromTxnDate.SetValue(DateTime.Parse("12/15/2007")); //Set field value for ToTxnDate TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDateRangeFilter.ORTransactionDateRangeFilter.TxnDateRange.ToTxnDate.SetValue(DateTime.Parse("12/15/2007")); } if (ORTransactionDateRangeFilterElementType22556 == "DateMacro") { //Set field value for DateMacro TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDateRangeFilter.ORTransactionDateRangeFilter.DateMacro.SetValue(ENDateMacro.dmAll); } string ORTransactionEntityFilterElementType22557 = "EntityTypeFilter"; if (ORTransactionEntityFilterElementType22557 == "EntityTypeFilter") { //Set field value for EntityTypeFilter TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.EntityTypeFilter.SetValue(ENEntityTypeFilter.etfCustomer); } if (ORTransactionEntityFilterElementType22557 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.ListIDList.Add("200000-1011023419"); } if (ORTransactionEntityFilterElementType22557 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.FullNameList.Add("ab"); } if (ORTransactionEntityFilterElementType22557 == "ListIDWithChildren") { //Set field value for ListIDWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.ListIDWithChildren.SetValue("200000-1011023419"); } if (ORTransactionEntityFilterElementType22557 == "FullNameWithChildren") { //Set field value for FullNameWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionEntityFilter.ORTransactionEntityFilter.FullNameWithChildren.SetValue("ab"); } string ORTransactionAccountFilterElementType22558 = "AccountTypeFilter"; if (ORTransactionAccountFilterElementType22558 == "AccountTypeFilter") { //Set field value for AccountTypeFilter TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.AccountTypeFilter.SetValue(ENAccountTypeFilter.atfAccountsPayable); } if (ORTransactionAccountFilterElementType22558 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.ListIDList.Add("200000-1011023419"); } if (ORTransactionAccountFilterElementType22558 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.FullNameList.Add("ab"); } if (ORTransactionAccountFilterElementType22558 == "ListIDWithChildren") { //Set field value for ListIDWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.ListIDWithChildren.SetValue("200000-1011023419"); } if (ORTransactionAccountFilterElementType22558 == "FullNameWithChildren") { //Set field value for FullNameWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionAccountFilter.ORTransactionAccountFilter.FullNameWithChildren.SetValue("ab"); } string ORTransactionItemFilterElementType22559 = "ItemTypeFilter"; if (ORTransactionItemFilterElementType22559 == "ItemTypeFilter") { //Set field value for ItemTypeFilter TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.ItemTypeFilter.SetValue(ENItemTypeFilter.itfAllExceptFixedAsset); } if (ORTransactionItemFilterElementType22559 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.ListIDList.Add("200000-1011023419"); } if (ORTransactionItemFilterElementType22559 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.FullNameList.Add("ab"); } if (ORTransactionItemFilterElementType22559 == "ListIDWithChildren") { //Set field value for ListIDWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.ListIDWithChildren.SetValue("200000-1011023419"); } if (ORTransactionItemFilterElementType22559 == "FullNameWithChildren") { //Set field value for FullNameWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionItemFilter.ORTransactionItemFilter.FullNameWithChildren.SetValue("ab"); } string ORTransactionClassFilterElementType22560 = "ListIDList"; if (ORTransactionClassFilterElementType22560 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.ListIDList.Add("200000-1011023419"); } if (ORTransactionClassFilterElementType22560 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.FullNameList.Add("ab"); } if (ORTransactionClassFilterElementType22560 == "ListIDWithChildren") { //Set field value for ListIDWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.ListIDWithChildren.SetValue("200000-1011023419"); } if (ORTransactionClassFilterElementType22560 == "FullNameWithChildren") { //Set field value for FullNameWithChildren TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionClassFilter.ORTransactionClassFilter.FullNameWithChildren.SetValue("ab"); } //Set field value for TxnTypeFilterList TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionTypeFilter.TxnTypeFilterList.SetValue(ENTxnTypeFilterList.ttflAll); //Set field value for TransactionDetailLevelFilter TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionDetailLevelFilter.SetValue(ENTransactionDetailLevelFilter.tdlfAll); //Set field value for TransactionPostingStatusFilter TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionPostingStatusFilter.SetValue(ENTransactionPostingStatusFilter.tpsfEither [DEFAULT]); //Set field value for TransactionPaidStatusFilter TransactionQueryRq.ORTransactionQuery.TransactionFilter.TransactionPaidStatusFilter.SetValue(ENTransactionPaidStatusFilter.tpsffEither [DEFAULT]); string ORCurrencyFilterElementType22561 = "ListIDList"; if (ORCurrencyFilterElementType22561 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.CurrencyFilter.ORCurrencyFilter.ListIDList.Add("200000-1011023419"); } if (ORCurrencyFilterElementType22561 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed TransactionQueryRq.ORTransactionQuery.TransactionFilter.CurrencyFilter.ORCurrencyFilter.FullNameList.Add("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed TransactionQueryRq.IncludeRetElementList.Add("ab"); } void WalkTransactionQueryRs(IMsgSetResponse responseMsgSet) { if (responseMsgSet == null) return; IResponseList responseList = responseMsgSet.ResponseList; if (responseList == null) return; //if we sent only one request, there is only one response, we'll walk the list for this sample for(int i=0; i < responseList.Count; i++) { IResponse response = responseList.GetAt(i); //check the status code of the response, 0=ok, >0 is warning if (response.StatusCode >= 0) { //the request-specific response is in the details, make sure we have some if (response.Detail != null) { //make sure the response is the type we're expecting ENResponseType responseType = (ENResponseType)response.Type.GetValue(); if (responseType == ENResponseType.rtTransactionQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above ITransactionRetList TransactionRet = (ITransactionRetList)response.Detail; WalkTransactionRet(TransactionRet); } } } } } void WalkTransactionRet(ITransactionRetList TransactionRet) { if (TransactionRet == null) return; //Go through all the elements of ITransactionRetList //Get value of TxnType if (TransactionRet.TxnType != null) { ENTxnType TxnType22562 = (ENTxnType)TransactionRet.TxnType.GetValue(); } //Get value of TxnID if (TransactionRet.TxnID != null) { string TxnID22563 = (string)TransactionRet.TxnID.GetValue(); } //Get value of TxnLineID if (TransactionRet.TxnLineID != null) { string TxnLineID22564 = (string)TransactionRet.TxnLineID.GetValue(); } //Get value of TimeCreated if (TransactionRet.TimeCreated != null) { DateTime TimeCreated22565 = (DateTime)TransactionRet.TimeCreated.GetValue(); } //Get value of TimeModified if (TransactionRet.TimeModified != null) { DateTime TimeModified22566 = (DateTime)TransactionRet.TimeModified.GetValue(); } if (TransactionRet.EntityRef != null) { //Get value of ListID if (TransactionRet.EntityRef.ListID != null) { string ListID22567 = (string)TransactionRet.EntityRef.ListID.GetValue(); } //Get value of FullName if (TransactionRet.EntityRef.FullName != null) { string FullName22568 = (string)TransactionRet.EntityRef.FullName.GetValue(); } } if (TransactionRet.AccountRef != null) { //Get value of ListID if (TransactionRet.AccountRef.ListID != null) { string ListID22569 = (string)TransactionRet.AccountRef.ListID.GetValue(); } //Get value of FullName if (TransactionRet.AccountRef.FullName != null) { string FullName22570 = (string)TransactionRet.AccountRef.FullName.GetValue(); } } //Get value of TxnDate if (TransactionRet.TxnDate != null) { DateTime TxnDate22571 = (DateTime)TransactionRet.TxnDate.GetValue(); } //Get value of RefNumber if (TransactionRet.RefNumber != null) { string RefNumber22572 = (string)TransactionRet.RefNumber.GetValue(); } //Get value of Amount if (TransactionRet.Amount != null) { double Amount22573 = (double)TransactionRet.Amount.GetValue(); } if (TransactionRet.CurrencyRef != null) { //Get value of ListID if (TransactionRet.CurrencyRef.ListID != null) { string ListID22574 = (string)TransactionRet.CurrencyRef.ListID.GetValue(); } //Get value of FullName if (TransactionRet.CurrencyRef.FullName != null) { string FullName22575 = (string)TransactionRet.CurrencyRef.FullName.GetValue(); } } //Get value of ExchangeRate if (TransactionRet.ExchangeRate != null) { IQBFloatType ExchangeRate22576 = (IQBFloatType)TransactionRet.ExchangeRate.GetValue(); } //Get value of AmountInHomeCurrency if (TransactionRet.AmountInHomeCurrency != null) { double AmountInHomeCurrency22577 = (double)TransactionRet.AmountInHomeCurrency.GetValue(); } //Get value of Memo if (TransactionRet.Memo != null) { string Memo22578 = (string)TransactionRet.Memo.GetValue(); } } } } |