BillPaymentCheckQuery(2.0)

Provides functionality found in the Find/Advanced Find window to find bill payments paid by check. The Find/Advanced Find windows can be reached by clicking the Find button on the main QuickBooks menubar, by selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that you can use the metaData attribute inside the query tag if you want only a count of the bill payments that will be returned from the query.
If you know the bill payment transaction ID or reference number, you could use these, or search by transaction date, or search by the date where the bill was last modified.
If you need additional filters, you can use the entity filter to search for bills from a specific vendor or vendor sub (using the ListIDWithChildren or FullNameWithChildren tags). You can also search for bills entered against a particular account (the APAccountRef specified in the originating BillAdd request). You can specify all subaccounts by using the various *WithChildren tags. For example, to find all bills entered against Checking where you have multiple checking accounts, you would use the ListIDWithChildren or FullNameWithChildren tags inside your AccountFilter tags. Finally, you can filter on the RefNumber or RefNumber range. Notice that all of these filters can be used together (ANDed) if desired.
To prevent the return of too much data, you can use MaxReturned to limit the total number of bills returned from the query. In addition, you can limit the type of data that is returned for each bill, using IncludeRetElement. Finally, you can specify whether each bill contains line items using the IncludeLineItems, which by default is False (no line item data).

Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

IBillPaymentCheckQuery

Provides functionality found in the Find/Advanced Find window to find bill payments paid by check. The Find/Advanced Find windows can be reached by clicking the Find button on the main QuickBooks menubar, by selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that you can use the metaData attribute inside the query tag if you want only a count of the bill payments that will be returned from the query. If you know the bill payment transaction ID or reference number, you could use these, or search by transaction date, or search by the date where the bill was last modified. If you need additional filters, you can use the entity filter to search for bills from a specific vendor or vendor sub (using the ListIDWithChildren or FullNameWithChildren tags). You can also search for bills entered against a particular account (the APAccountRef specified in the originating BillAdd request). You can specify all subaccounts by using the various *WithChildren tags. For example, to find all bills entered against Checking where you have multiple checking accounts, you would use the ListIDWithChildren or FullNameWithChildren tags inside your AccountFilter tags. Finally, you can filter on the RefNumber or RefNumber range. Notice that all of these filters can be used together (ANDed) if desired. To prevent the return of too much data, you can use MaxReturned to limit the total number of bills returned from the query. In addition, you can limit the type of data that is returned for each bill, using IncludeRetElement. Finally, you can specify whether each bill contains line items using the IncludeLineItems, which by default is False (no line item data).
     2.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 us.png  

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 us.png  

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 us.png  

ORTxnQuery

 IORTxnQuery      

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      

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  

TxnFilter

The ITxnFilter group object allows you to search according to various criteria.
 ITxnFilter      

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      

ORDateRangeFilter

 IORDateRangeFilter      

ModifiedDateRangeFilter

Filters according to the dates when transactions were last modified. The ModifiedDateRangeFilter aggregate is not required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the FromModifiedDate and ToModifiedDate fields was not supported in qbXML version 1.0 or 1.1. (To filter according to the dates when transactions were deleted, use a TxnDeletedQuery message.)
 IModifiedDateRangeFilter      

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      

TxnDateRangeFilter

Filters according to the original transaction dates.
 ITxnDateRangeFilter      

ORTxnDateRangeFilter

 IORTxnDateRangeFilter     Y

TxnDateFilter

The ITxnDateFilter group object allows you to filter by transaction creation date.
 ITxnDateFilter      

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      

EntityFilter

An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an EntityQuery request to get information about all the entities that are set up in the QuickBooks file. In an ARRefundCreditCard query, this must be a customer/customer job.
 IEntityFilter      

OREntityFilter

 IOREntityFilter     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   2.0  

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   2.0  

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      

AccountFilter

Filters according to the account name or ListID. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for FullName and get the account you’re looking for. But if numbers have been used as account names, confusion could arise. For example, if you queried for an account named 2050, and 2050 happened to be the account number of a totally different account, the query would not return what you asked for (the account named 2050), but instead would return the account with the account number 2050. This problem will not happen if the “Use account numbers” preference is turned off in the QuickBooks file, orthe account name exactly matches the account number. (In this case, query would return the correct account either way.) To avoid this problem: Do not name an account using a number unless the number exactly matches the account’s account number. If an account name must contain a number that does not match its own account number, have the QuickBooks user change the account’s name slightly, for example to 2050a.
 IAccountFilter      

ORAccountFilter

 IORAccountFilter     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   2.0  

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   2.0  

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      

ORRefNumberFilter

 IORRefNumberFilter      

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      

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    

IncludeLineItems

This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set IncludeLineItems to true to include line items in the response if you don’t mind getting a larger result.
 IQBBoolType      

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 4.0  

OwnerIDList

Zero or more OwnerID values. OwnerID refers to the owner of a data extension:If OwnerID is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If OwnerID is a GUID, for example {6B063959-81B0-4622-85D6-F548C8CCB517}, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that OwnerID values are not case-sensitive, meaning that if you enter an OwnerID value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IGUIDList   2.0  
Tag Type Max length Implementation Required

IResponse

Provides functionality found in the Find/Advanced Find window to find bill payments paid by check. The Find/Advanced Find windows can be reached by clicking the Find button on the main QuickBooks menubar, by selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that you can use the metaData attribute inside the query tag if you want only a count of the bill payments that will be returned from the query. If you know the bill payment transaction ID or reference number, you could use these, or search by transaction date, or search by the date where the bill was last modified. If you need additional filters, you can use the entity filter to search for bills from a specific vendor or vendor sub (using the ListIDWithChildren or FullNameWithChildren tags). You can also search for bills entered against a particular account (the APAccountRef specified in the originating BillAdd request). You can specify all subaccounts by using the various *WithChildren tags. For example, to find all bills entered against Checking where you have multiple checking accounts, you would use the ListIDWithChildren or FullNameWithChildren tags inside your AccountFilter tags. Finally, you can filter on the RefNumber or RefNumber range. Notice that all of these filters can be used together (ANDed) if desired. To prevent the return of too much data, you can use MaxReturned to limit the total number of bills returned from the query. In addition, you can limit the type of data that is returned for each bill, using IncludeRetElement. Finally, you can specify whether each bill contains line items using the IncludeLineItems, which by default is False (no line item data).
     2.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 us.png 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 us.png 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 us.png Y

Detail

 IBillPaymentCheckRetList      

(List

of IBillPaymentCheckRet Objects)
        

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      

TimeCreated

Time the object was created.
 IQBDateTimeType      

TimeModified

Time the object was last modified.
 IQBDateTimeType      

EditSequence

A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
 IQBStringType 16 chars    

TxnNumber

An identifying number for this transaction.
 IQBIntType      

PayeeEntityRef

Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a PayeeEntityRef aggregate includes both FullName and ListID, FullName will be ignored. In a Check message, PayeeEntityRef refers to the person or company to whom the check is written. In CreditCardCharge and CreditCardCredit messages, PayeeEntityRef refers to the vendor or company from whom merchandise was purchased. (PayeeEntityRef corresponds to the choice in the Purchased From list in QuickBooks.)
 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    

APAccountRef

Refers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.) If APAccountRef is missing, the SDK will use the QuickBooks default AP account. In a request, if an APAccountRef aggregate includes both FullName and ListID, FullName will be ignored.
 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      

BankAccountRef

Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a BankAccountRef aggregate includes both FullName and ListID, FullName will be ignored.
 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    

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  

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 11 chars    

Memo

Additional information.
 IQBStringType 4095 chars    

Address

If an address request fails, some combination of address fields might be too long. In a Check, BillPaymentCheck, or SalesTaxPaymentCheck message, Address is the address that will print on the check.
 IAddress      

Addr1

The first line of an address.
 IQBStringType 41 chars    

Addr2

The second line of an address (if a second line is needed).
 IQBStringType 41 chars    

Addr3

The third line of an address (if a third line is needed).
 IQBStringType 41 chars    

Addr4

The fourth line of an address (if a fourth line is needed).
 IQBStringType 41 chars 2.0  

Addr5

The fifth line of an address (if a fifth line is needed).
 IQBStringType 41 chars 6.0  

City

The city name in an address.
 IQBStringType 31 chars    

State

The state name in an address.
 IQBStringType 21 chars    

PostalCode

The postal code in an address.
 IQBStringType 13 chars    

Country

The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.)
 IQBStringType 31 chars    

Note

In a BillAddress or ShipAddress aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form.
 IQBStringType 41 chars 6.0  

AddressBlock

The address expressed as an address block of Addr1 through Addr5, depending on the number of lines in the original request that created the address.
 IAddressBlock   6.0  

Addr1

The first line of an address.
 IQBStringType 41 chars    

Addr2

The second line of an address (if a second line is needed).
 IQBStringType 41 chars    

Addr3

The third line of an address (if a third line is needed).
 IQBStringType 41 chars    

Addr4

The fourth line of an address (if a fourth line is needed).
 IQBStringType 41 chars    

Addr5

The fifth line of an address (if a fifth line is needed).
 IQBStringType 41 chars    

IsToBePrinted

If IsToBePrinted is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once. Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed.
 IQBBoolType      

ExternalGUID

Allows for the attachment of a user defined GUID value.
 IQBGUIDType   9.0  

AppliedToTxnRetList

AppliedToTxn List A list of AppliedToTxn aggregates.
 IAppliedToTxnRetList      

(List

of IAppliedToTxnRet Objects)
        

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     Y

TxnType

The type of transaction.
 IQBENTxnTypeType     Y

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 20 chars    

BalanceRemaining

The outstanding balance on this invoice. BalanceRemaining = (Subtotal + SalesTaxTotal) – AppliedAmount.
 IQBAmountType      

Amount

A monetary amount.
 IQBAmountType      

DiscountAmount

Reduces the receivable amount.
 IQBAmountType      

DiscountAccountRef

Refers to the account where this discount is tracked. In a request, if a DiscountAccountRef aggregate includes both FullName and ListID, FullName will be ignored.
 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    

DiscountClassRef

Class reference used in the Discount object
 IQBBaseRef   11.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   11.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 159 chars 11.0  

LinkedTxnList

If the IncludeLinkedTxns flag is set to true in a query, or if you create an item receipt that links to other transactionsthen the returned object will include a list of linked transactions, if any exist. If no linked transactions exist, the ILinkedTxnList object will be empty. The list of linked transactions is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items.
 ILinkedTxnList   10.0  

(List

of ILinkedTxn Objects)
        

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     Y

TxnType

The type of transaction.
 IQBENTxnTypeType     Y

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     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 20 chars    

LinkType

Indicates the nature of the link between the transactions:ltAMTTYPE means the two transactions are linked based on an amount value (for example an invoice linked to a payment).ltQUANTYPE means the two transactions are linked based on a quantity. This affects transactions that are linked to sales orders, estimates and purchase orders. For example, an invoice might be created from a sales order, based on the quantity of items received.
 IQBENLinkTypeType   3.0  

Amount

A monetary amount.
 IQBAmountType     Y

DataExtRetList

A list of IDataExtRet objects, each of which represents a field that has been added to QuickBooks as a data extension.
 IDataExtRetList      

(List

of IDataExtRet Objects)
        

OwnerID

OwnerID refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an OwnerID of 0. ) Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IQBGUIDType      

DataExtName

The name of the data extension. If this is a custom field, DataExtName will be visible as a label in the QuickBooks user interface. Also because OwnerID and DataExtName together make the data extension unique, and because custom fields all have the same OwnerID of zero, the DataExtName must be a unique value among existing custom fields. In contrast, the DataExtName for private data extensions must be unique only for the specified OwnerID GUID.
 IQBStringType 31 chars   Y

DataExtType

The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, DataExtType must be detSTR255TYPE.
 IQBENDataExtTypeType     Y

DataExtValue

The data in this field. The maximum length of DataExtValue will depend on the DataExtType of this data extension. For example, if DataExtType is STR255TYPE, the maximum length of DataExtValue is 255 characters. If DataExtType is STR1024TYPE, the maximum size of DataExtValue is 1KB.
 IQBStringType     Y 

  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
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <BillPaymentCheckQueryRq metaData="ENUMTYPE" iterator="ENUMTYPE" iteratorID="UUIDTYPE">
                        <!-- BEGIN OR -->
                                <TxnID >IDTYPE</TxnID> <!-- optional, may repeat -->
                        <!-- OR -->
                                <RefNumber >STRTYPE</RefNumber> <!-- optional, may repeat -->
                        <!-- OR -->
                                <RefNumberCaseSensitive >STRTYPE</RefNumberCaseSensitive> <!-- optional, may repeat -->
                        <!-- OR -->
                                <MaxReturned >INTTYPE</MaxReturned> <!-- optional -->
                                <!-- BEGIN OR -->
                                        <ModifiedDateRangeFilter> <!-- optional -->
                                                <FromModifiedDate >DATETIMETYPE</FromModifiedDate> <!-- optional -->
                                                <ToModifiedDate >DATETIMETYPE</ToModifiedDate> <!-- optional -->
                                        </ModifiedDateRangeFilter>
                                <!-- OR -->
                                        <TxnDateRangeFilter> <!-- 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 -->
                                        </TxnDateRangeFilter>
                                <!-- END OR -->
                                <EntityFilter> <!-- 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 -->
                                </EntityFilter>
                                <AccountFilter> <!-- 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 -->
                                </AccountFilter>
                                <!-- BEGIN 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 -->
                                <CurrencyFilter> <!-- optional -->
                                        <!-- BEGIN OR -->
                                                <ListID >IDTYPE</ListID> <!-- optional, may repeat -->
                                        <!-- OR -->
                                                <FullName >STRTYPE</FullName> <!-- optional, may repeat -->
                                        <!-- END OR -->
                                </CurrencyFilter>
                        <!-- END OR -->
                        <IncludeLineItems >BOOLTYPE</IncludeLineItems> <!-- optional -->
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                        <OwnerID >GUIDTYPE</OwnerID> <!-- optional, may repeat -->
                </BillPaymentCheckQueryRq>

                <BillPaymentCheckQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE" iteratorRemainingCount="INTTYPE" iteratorID="UUIDTYPE">
                        <BillPaymentCheckRet> <!-- optional, may repeat -->
                                <TxnID >IDTYPE</TxnID> <!-- optional -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- optional -->
                                <EditSequence >STRTYPE</EditSequence> <!-- optional -->
                                <TxnNumber >INTTYPE</TxnNumber> <!-- optional -->
                                <PayeeEntityRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </PayeeEntityRef>
                                <APAccountRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </APAccountRef>
                                <TxnDate >DATETYPE</TxnDate> <!-- optional -->
                                <BankAccountRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </BankAccountRef>
                                <Amount >AMTTYPE</Amount> <!-- optional -->
                                <CurrencyRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </CurrencyRef>
                                <ExchangeRate >FLOATTYPE</ExchangeRate> <!-- optional -->
                                <AmountInHomeCurrency >AMTTYPE</AmountInHomeCurrency> <!-- optional -->
                                <RefNumber >STRTYPE</RefNumber> <!-- optional -->
                                <Memo >STRTYPE</Memo> <!-- optional -->
                                <Address> <!-- optional -->
                                        <Addr1 >STRTYPE</Addr1> <!-- optional -->
                                        <Addr2 >STRTYPE</Addr2> <!-- optional -->
                                        <Addr3 >STRTYPE</Addr3> <!-- optional -->
                                        <Addr4 >STRTYPE</Addr4> <!-- optional -->
                                        <Addr5 >STRTYPE</Addr5> <!-- optional -->
                                        <City >STRTYPE</City> <!-- optional -->
                                        <State >STRTYPE</State> <!-- optional -->
                                        <PostalCode >STRTYPE</PostalCode> <!-- optional -->
                                        <Country >STRTYPE</Country> <!-- optional -->
                                        <Note >STRTYPE</Note> <!-- optional -->
                                </Address>
                                <AddressBlock> <!-- optional -->
                                        <Addr1 >STRTYPE</Addr1> <!-- optional -->
                                        <Addr2 >STRTYPE</Addr2> <!-- optional -->
                                        <Addr3 >STRTYPE</Addr3> <!-- optional -->
                                        <Addr4 >STRTYPE</Addr4> <!-- optional -->
                                        <Addr5 >STRTYPE</Addr5> <!-- optional -->
                                </AddressBlock>
                                <IsToBePrinted >BOOLTYPE</IsToBePrinted> <!-- optional -->
                                <ExternalGUID >GUIDTYPE</ExternalGUID> <!-- optional -->
                                <AppliedToTxnRet> <!-- optional, may repeat -->
                                        <TxnID >IDTYPE</TxnID> <!-- required -->
                                        <!-- 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> <!-- required -->
                                        <TxnDate >DATETYPE</TxnDate> <!-- optional -->
                                        <RefNumber >STRTYPE</RefNumber> <!-- optional -->
                                        <BalanceRemaining >AMTTYPE</BalanceRemaining> <!-- optional -->
                                        <Amount >AMTTYPE</Amount> <!-- optional -->
                                        <DiscountAmount >AMTTYPE</DiscountAmount> <!-- optional -->
                                        <DiscountAccountRef> <!-- optional -->
                                                <ListID >IDTYPE</ListID> <!-- optional -->
                                                <FullName >STRTYPE</FullName> <!-- optional -->
                                        </DiscountAccountRef>
                                        <DiscountClassRef> <!-- optional -->
                                                <ListID >IDTYPE</ListID> <!-- optional -->
                                                <FullName >STRTYPE</FullName> <!-- optional -->
                                        </DiscountClassRef>
                                        <LinkedTxn> <!-- optional, may repeat -->
                                                <TxnID >IDTYPE</TxnID> <!-- required -->
                                                <!-- 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> <!-- required -->
                                                <TxnDate >DATETYPE</TxnDate> <!-- required -->
                                                <RefNumber >STRTYPE</RefNumber> <!-- optional -->
                                                <!-- LinkType may have one of the following values: AMTTYPE, QUANTYPE -->
                                                <LinkType >ENUMTYPE</LinkType> <!-- optional -->
                                                <Amount >AMTTYPE</Amount> <!-- required -->
                                        </LinkedTxn>
                                </AppliedToTxnRet>
                                <DataExtRet> <!-- optional, may repeat -->
                                        <OwnerID >GUIDTYPE</OwnerID> <!-- optional -->
                                        <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                        <!-- DataExtType may have one of the following values: AMTTYPE, DATETIMETYPE, INTTYPE, PERCENTTYPE, PRICETYPE, QUANTYPE, STR1024TYPE, STR255TYPE -->
                                        <DataExtType >ENUMTYPE</DataExtType> <!-- required -->
                                        <DataExtValue >STRTYPE</DataExtValue> <!-- required -->
                                </DataExtRet>
                        </BillPaymentCheckRet>
                </BillPaymentCheckQueryRs>
        </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
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
'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  DoBillPaymentCheckQuery()
                        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

                                BuildBillPaymentCheckQueryRq(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

                                WalkBillPaymentCheckQueryRs(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 BuildBillPaymentCheckQueryRq(requestMsgSet as IMsgSetRequest)
                        Dim BillPaymentCheckQueryRq as IBillPaymentCheckQuery
                        BillPaymentCheckQueryRq= requestMsgSet.AppendBillPaymentCheckQueryRq()
                        Dim ORTxnQueryElementType1478 as String
                        ORTxnQueryElementType1478 = "TxnIDList"
                        if (ORTxnQueryElementType1478 == "TxnIDList") then
                                'Set field value for TxnIDList
                                'May create more than one of these if needed
                                BillPaymentCheckQueryRq.ORTxnQuery.TxnIDList.Add("200000-1011023419")
                        End If
                        if (ORTxnQueryElementType1478 == "RefNumberList") then
                                'Set field value for RefNumberList
                                'May create more than one of these if needed
                                BillPaymentCheckQueryRq.ORTxnQuery.RefNumberList.Add("ab")
                        End If
                        if (ORTxnQueryElementType1478 == "RefNumberCaseSensitiveList") then
                                'Set field value for RefNumberCaseSensitiveList
                                'May create more than one of these if needed
                                BillPaymentCheckQueryRq.ORTxnQuery.RefNumberCaseSensitiveList.Add("ab")
                        End If
                        if (ORTxnQueryElementType1478 == "TxnFilter") then
                                'Set field value for MaxReturned
                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.MaxReturned.SetValue(6)
                                Dim ORDateRangeFilterElementType1479 as String
                                ORDateRangeFilterElementType1479 = "ModifiedDateRangeFilter"
                                if (ORDateRangeFilterElementType1479 == "ModifiedDateRangeFilter") then
                                        'Set field value for FromModifiedDate
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.ModifiedDateRangeFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
                                        'Set field value for ToModifiedDate
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.ModifiedDateRangeFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
                                End If
                                if (ORDateRangeFilterElementType1479 == "TxnDateRangeFilter") then
                                        Dim ORTxnDateRangeFilterElementType1480 as String
                                        ORTxnDateRangeFilterElementType1480 = "TxnDateFilter"
                                        if (ORTxnDateRangeFilterElementType1480 == "TxnDateFilter") then
                                                'Set field value for FromTxnDate
                                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.TxnDateRangeFilter.ORTxnDateRangeFilter.TxnDateFilter.FromTxnDate.SetValue(DateTime.Parse("12/15/2007"))
                                                'Set field value for ToTxnDate
                                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.TxnDateRangeFilter.ORTxnDateRangeFilter.TxnDateFilter.ToTxnDate.SetValue(DateTime.Parse("12/15/2007"))
                                        End If
                                        if (ORTxnDateRangeFilterElementType1480 == "DateMacro") then
                                                'Set field value for DateMacro
                                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.TxnDateRangeFilter.ORTxnDateRangeFilter.DateMacro.SetValue(ENDateMacro.dmAll)
                                        End If
                                End If
                                Dim OREntityFilterElementType1481 as String
                                OREntityFilterElementType1481 = "ListIDList"
                                if (OREntityFilterElementType1481 == "ListIDList") then
                                        'Set field value for ListIDList
                                        'May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.ListIDList.Add("200000-1011023419")
                                End If
                                if (OREntityFilterElementType1481 == "FullNameList") then
                                        'Set field value for FullNameList
                                        'May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.FullNameList.Add("ab")
                                End If
                                if (OREntityFilterElementType1481 == "ListIDWithChildren") then
                                        'Set field value for ListIDWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.ListIDWithChildren.SetValue("200000-1011023419")
                                End If
                                if (OREntityFilterElementType1481 == "FullNameWithChildren") then
                                        'Set field value for FullNameWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.FullNameWithChildren.SetValue("ab")
                                End If
                                Dim ORAccountFilterElementType1482 as String
                                ORAccountFilterElementType1482 = "ListIDList"
                                if (ORAccountFilterElementType1482 == "ListIDList") then
                                        'Set field value for ListIDList
                                        'May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.ListIDList.Add("200000-1011023419")
                                End If
                                if (ORAccountFilterElementType1482 == "FullNameList") then
                                        'Set field value for FullNameList
                                        'May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.FullNameList.Add("ab")
                                End If
                                if (ORAccountFilterElementType1482 == "ListIDWithChildren") then
                                        'Set field value for ListIDWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.ListIDWithChildren.SetValue("200000-1011023419")
                                End If
                                if (ORAccountFilterElementType1482 == "FullNameWithChildren") then
                                        'Set field value for FullNameWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.FullNameWithChildren.SetValue("ab")
                                End If
                                Dim ORRefNumberFilterElementType1483 as String
                                ORRefNumberFilterElementType1483 = "RefNumberFilter"
                                if (ORRefNumberFilterElementType1483 == "RefNumberFilter") then
                                        'Set field value for MatchCriterion
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
                                        'Set field value for RefNumber
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberFilter.RefNumber.SetValue("ab")
                                End If
                                if (ORRefNumberFilterElementType1483 == "RefNumberRangeFilter") then
                                        'Set field value for FromRefNumber
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberRangeFilter.FromRefNumber.SetValue("ab")
                                        'Set field value for ToRefNumber
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberRangeFilter.ToRefNumber.SetValue("ab")
                                End If
                                Dim ORCurrencyFilterElementType1484 as String
                                ORCurrencyFilterElementType1484 = "ListIDList"
                                if (ORCurrencyFilterElementType1484 == "ListIDList") then
                                        'Set field value for ListIDList
                                        'May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.CurrencyFilter.ORCurrencyFilter.ListIDList.Add("200000-1011023419")
                                End If
                                if (ORCurrencyFilterElementType1484 == "FullNameList") then
                                        'Set field value for FullNameList
                                        'May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.CurrencyFilter.ORCurrencyFilter.FullNameList.Add("ab")
                                End If
                        End If
                        'Set field value for IncludeLineItems
                        BillPaymentCheckQueryRq.IncludeLineItems.SetValue(True)
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        BillPaymentCheckQueryRq.IncludeRetElementList.Add("ab")
                        'Set field value for OwnerIDList
                        'May create more than one of these if needed
                        BillPaymentCheckQueryRq.OwnerIDList.Add(System.Guid.NewGuid().ToString())
                End Sub




                Public Sub WalkBillPaymentCheckQueryRs( 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.rtBillPaymentCheckQueryRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim BillPaymentCheckRet as IBillPaymentCheckRetList
                                                        BillPaymentCheckRet = CType(response.Detail,IBillPaymentCheckRetList)
                                                        WalkBillPaymentCheckRet(BillPaymentCheckRet)
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkBillPaymentCheckRet(BillPaymentCheckRet as IBillPaymentCheckRetList)
                        if (BillPaymentCheckRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IBillPaymentCheckRetList
                        'Get value of TxnID
                        if ( not BillPaymentCheckRet.TxnID is nothing) then
                                Dim TxnID1485 as String
                                TxnID1485 = BillPaymentCheckRet.TxnID.GetValue()
                        End If
                        'Get value of TimeCreated
                        if ( not BillPaymentCheckRet.TimeCreated is nothing) then
                                Dim TimeCreated1486 as DateTime
                                TimeCreated1486 = BillPaymentCheckRet.TimeCreated.GetValue()
                        End If
                        'Get value of TimeModified
                        if ( not BillPaymentCheckRet.TimeModified is nothing) then
                                Dim TimeModified1487 as DateTime
                                TimeModified1487 = BillPaymentCheckRet.TimeModified.GetValue()
                        End If
                        'Get value of EditSequence
                        if ( not BillPaymentCheckRet.EditSequence is nothing) then
                                Dim EditSequence1488 as String
                                EditSequence1488 = BillPaymentCheckRet.EditSequence.GetValue()
                        End If
                        'Get value of TxnNumber
                        if ( not BillPaymentCheckRet.TxnNumber is nothing) then
                                Dim TxnNumber1489 as Integer
                                TxnNumber1489 = BillPaymentCheckRet.TxnNumber.GetValue()
                        End If
                        if (not BillPaymentCheckRet.PayeeEntityRef. is nothing) then
                                'Get value of ListID
                                if ( not BillPaymentCheckRet.PayeeEntityRef.ListID is nothing) then
                                        Dim ListID1490 as String
                                        ListID1490 = BillPaymentCheckRet.PayeeEntityRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not BillPaymentCheckRet.PayeeEntityRef.FullName is nothing) then
                                        Dim FullName1491 as String
                                        FullName1491 = BillPaymentCheckRet.PayeeEntityRef.FullName.GetValue()
                                End If
                        End If
                        if (not BillPaymentCheckRet.APAccountRef. is nothing) then
                                'Get value of ListID
                                if ( not BillPaymentCheckRet.APAccountRef.ListID is nothing) then
                                        Dim ListID1492 as String
                                        ListID1492 = BillPaymentCheckRet.APAccountRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not BillPaymentCheckRet.APAccountRef.FullName is nothing) then
                                        Dim FullName1493 as String
                                        FullName1493 = BillPaymentCheckRet.APAccountRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of TxnDate
                        if ( not BillPaymentCheckRet.TxnDate is nothing) then
                                Dim TxnDate1494 as DateTime
                                TxnDate1494 = BillPaymentCheckRet.TxnDate.GetValue()
                        End If
                        if (not BillPaymentCheckRet.BankAccountRef. is nothing) then
                                'Get value of ListID
                                if ( not BillPaymentCheckRet.BankAccountRef.ListID is nothing) then
                                        Dim ListID1495 as String
                                        ListID1495 = BillPaymentCheckRet.BankAccountRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not BillPaymentCheckRet.BankAccountRef.FullName is nothing) then
                                        Dim FullName1496 as String
                                        FullName1496 = BillPaymentCheckRet.BankAccountRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of Amount
                        if ( not BillPaymentCheckRet.Amount is nothing) then
                                Dim Amount1497 as Double
                                Amount1497 = BillPaymentCheckRet.Amount.GetValue()
                        End If
                        if (not BillPaymentCheckRet.CurrencyRef. is nothing) then
                                'Get value of ListID
                                if ( not BillPaymentCheckRet.CurrencyRef.ListID is nothing) then
                                        Dim ListID1498 as String
                                        ListID1498 = BillPaymentCheckRet.CurrencyRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not BillPaymentCheckRet.CurrencyRef.FullName is nothing) then
                                        Dim FullName1499 as String
                                        FullName1499 = BillPaymentCheckRet.CurrencyRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of ExchangeRate
                        if ( not BillPaymentCheckRet.ExchangeRate is nothing) then
                                Dim ExchangeRate16.0 as IQBFloatType
                                ExchangeRate16.0 = BillPaymentCheckRet.ExchangeRate.GetValue()
                        End If
                        'Get value of AmountInHomeCurrency
                        if ( not BillPaymentCheckRet.AmountInHomeCurrency is nothing) then
                                Dim AmountInHomeCurrency1501 as Double
                                AmountInHomeCurrency1501 = BillPaymentCheckRet.AmountInHomeCurrency.GetValue()
                        End If
                        'Get value of RefNumber
                        if ( not BillPaymentCheckRet.RefNumber is nothing) then
                                Dim RefNumber1502 as String
                                RefNumber1502 = BillPaymentCheckRet.RefNumber.GetValue()
                        End If
                        'Get value of Memo
                        if ( not BillPaymentCheckRet.Memo is nothing) then
                                Dim Memo1503 as String
                                Memo1503 = BillPaymentCheckRet.Memo.GetValue()
                        End If
                        if (not BillPaymentCheckRet.Address. is nothing) then
                                'Get value of Addr1
                                if ( not BillPaymentCheckRet.Address.Addr1 is nothing) then
                                        Dim Addr11504 as String
                                        Addr11504 = BillPaymentCheckRet.Address.Addr1.GetValue()
                                End If
                                'Get value of Addr2
                                if ( not BillPaymentCheckRet.Address.Addr2 is nothing) then
                                        Dim Addr21505 as String
                                        Addr21505 = BillPaymentCheckRet.Address.Addr2.GetValue()
                                End If
                                'Get value of Addr3
                                if ( not BillPaymentCheckRet.Address.Addr3 is nothing) then
                                        Dim Addr31506 as String
                                        Addr31506 = BillPaymentCheckRet.Address.Addr3.GetValue()
                                End If
                                'Get value of Addr4
                                if ( not BillPaymentCheckRet.Address.Addr4 is nothing) then
                                        Dim Addr41507 as String
                                        Addr41507 = BillPaymentCheckRet.Address.Addr4.GetValue()
                                End If
                                'Get value of Addr5
                                if ( not BillPaymentCheckRet.Address.Addr5 is nothing) then
                                        Dim Addr51508 as String
                                        Addr51508 = BillPaymentCheckRet.Address.Addr5.GetValue()
                                End If
                                'Get value of City
                                if ( not BillPaymentCheckRet.Address.City is nothing) then
                                        Dim City1509 as String
                                        City1509 = BillPaymentCheckRet.Address.City.GetValue()
                                End If
                                'Get value of State
                                if ( not BillPaymentCheckRet.Address.State is nothing) then
                                        Dim State16.0 as String
                                        State16.0 = BillPaymentCheckRet.Address.State.GetValue()
                                End If
                                'Get value of PostalCode
                                if ( not BillPaymentCheckRet.Address.PostalCode is nothing) then
                                        Dim PostalCode1511 as String
                                        PostalCode1511 = BillPaymentCheckRet.Address.PostalCode.GetValue()
                                End If
                                'Get value of Country
                                if ( not BillPaymentCheckRet.Address.Country is nothing) then
                                        Dim Country1512 as String
                                        Country1512 = BillPaymentCheckRet.Address.Country.GetValue()
                                End If
                                'Get value of Note
                                if ( not BillPaymentCheckRet.Address.Note is nothing) then
                                        Dim Note1513 as String
                                        Note1513 = BillPaymentCheckRet.Address.Note.GetValue()
                                End If
                        End If
                        if (not BillPaymentCheckRet.AddressBlock. is nothing) then
                                'Get value of Addr1
                                if ( not BillPaymentCheckRet.AddressBlock.Addr1 is nothing) then
                                        Dim Addr11514 as String
                                        Addr11514 = BillPaymentCheckRet.AddressBlock.Addr1.GetValue()
                                End If
                                'Get value of Addr2
                                if ( not BillPaymentCheckRet.AddressBlock.Addr2 is nothing) then
                                        Dim Addr21515 as String
                                        Addr21515 = BillPaymentCheckRet.AddressBlock.Addr2.GetValue()
                                End If
                                'Get value of Addr3
                                if ( not BillPaymentCheckRet.AddressBlock.Addr3 is nothing) then
                                        Dim Addr31516 as String
                                        Addr31516 = BillPaymentCheckRet.AddressBlock.Addr3.GetValue()
                                End If
                                'Get value of Addr4
                                if ( not BillPaymentCheckRet.AddressBlock.Addr4 is nothing) then
                                        Dim Addr41517 as String
                                        Addr41517 = BillPaymentCheckRet.AddressBlock.Addr4.GetValue()
                                End If
                                'Get value of Addr5
                                if ( not BillPaymentCheckRet.AddressBlock.Addr5 is nothing) then
                                        Dim Addr51518 as String
                                        Addr51518 = BillPaymentCheckRet.AddressBlock.Addr5.GetValue()
                                End If
                        End If
                        'Get value of IsToBePrinted
                        if ( not BillPaymentCheckRet.IsToBePrinted is nothing) then
                                Dim IsToBePrinted1519 as Boolean
                                IsToBePrinted1519 = BillPaymentCheckRet.IsToBePrinted.GetValue()
                        End If
                        'Get value of ExternalGUID
                        if ( not BillPaymentCheckRet.ExternalGUID is nothing) then
                                Dim ExternalGUID16.0 as String
                                ExternalGUID16.0 = BillPaymentCheckRet.ExternalGUID.GetValue()
                        End If
                        if (not BillPaymentCheckRet.AppliedToTxnRetList is nothing)
                                Dim i1521 as Integer
                                for i1521 = 0  to BillPaymentCheckRet.AppliedToTxnRetList.Count - 1
                                        Dim AppliedToTxnRet as IAppliedToTxnRet
                                        AppliedToTxnRet = BillPaymentCheckRet.AppliedToTxnRetList.GetAt(i1521)
                                        'Get value of TxnID
                                        Dim TxnID1522 as String
                                        TxnID1522 = AppliedToTxnRetTxnID.GetValue()
                                        'Get value of TxnType
                                        Dim TxnType1523 as ENTxnType
                                        TxnType1523 = AppliedToTxnRetTxnType.GetValue()
                                        'Get value of TxnDate
                                        if ( not AppliedToTxnRetTxnDate is nothing) then
                                                Dim TxnDate1524 as DateTime
                                                TxnDate1524 = AppliedToTxnRetTxnDate.GetValue()
                                        End If
                                        'Get value of RefNumber
                                        if ( not AppliedToTxnRetRefNumber is nothing) then
                                                Dim RefNumber1525 as String
                                                RefNumber1525 = AppliedToTxnRetRefNumber.GetValue()
                                        End If
                                        'Get value of BalanceRemaining
                                        if ( not AppliedToTxnRetBalanceRemaining is nothing) then
                                                Dim BalanceRemaining1526 as Double
                                                BalanceRemaining1526 = AppliedToTxnRetBalanceRemaining.GetValue()
                                        End If
                                        'Get value of Amount
                                        if ( not AppliedToTxnRetAmount is nothing) then
                                                Dim Amount1527 as Double
                                                Amount1527 = AppliedToTxnRetAmount.GetValue()
                                        End If
                                        'Get value of DiscountAmount
                                        if ( not AppliedToTxnRetDiscountAmount is nothing) then
                                                Dim DiscountAmount1528 as Double
                                                DiscountAmount1528 = AppliedToTxnRetDiscountAmount.GetValue()
                                        End If
                                        if (not AppliedToTxnRetDiscountAccountRef. is nothing) then
                                                'Get value of ListID
                                                if ( not AppliedToTxnRetDiscountAccountRef.ListID is nothing) then
                                                        Dim ListID1529 as String
                                                        ListID1529 = AppliedToTxnRetDiscountAccountRef.ListID.GetValue()
                                                End If
                                                'Get value of FullName
                                                if ( not AppliedToTxnRetDiscountAccountRef.FullName is nothing) then
                                                        Dim FullName16.0 as String
                                                        FullName16.0 = AppliedToTxnRetDiscountAccountRef.FullName.GetValue()
                                                End If
                                        End If
                                        if (not AppliedToTxnRetDiscountClassRef. is nothing) then
                                                'Get value of ListID
                                                if ( not AppliedToTxnRetDiscountClassRef.ListID is nothing) then
                                                        Dim ListID1531 as String
                                                        ListID1531 = AppliedToTxnRetDiscountClassRef.ListID.GetValue()
                                                End If
                                                'Get value of FullName
                                                if ( not AppliedToTxnRetDiscountClassRef.FullName is nothing) then
                                                        Dim FullName1532 as String
                                                        FullName1532 = AppliedToTxnRetDiscountClassRef.FullName.GetValue()
                                                End If
                                        End If
                                        if (not AppliedToTxnRetLinkedTxnList is nothing)
                                                Dim i1533 as Integer
                                                for i1533 = 0  to AppliedToTxnRetLinkedTxnList.Count - 1
                                                        Dim LinkedTxn as ILinkedTxn
                                                        LinkedTxn = AppliedToTxnRetLinkedTxnList.GetAt(i1533)
                                                        'Get value of TxnID
                                                        Dim TxnID1534 as String
                                                        TxnID1534 = LinkedTxnTxnID.GetValue()
                                                        'Get value of TxnType
                                                        Dim TxnType1535 as ENTxnType
                                                        TxnType1535 = LinkedTxnTxnType.GetValue()
                                                        'Get value of TxnDate
                                                        Dim TxnDate1536 as DateTime
                                                        TxnDate1536 = LinkedTxnTxnDate.GetValue()
                                                        'Get value of RefNumber
                                                        if ( not LinkedTxnRefNumber is nothing) then
                                                                Dim RefNumber1537 as String
                                                                RefNumber1537 = LinkedTxnRefNumber.GetValue()
                                                        End If
                                                        'Get value of LinkType
                                                        if ( not LinkedTxnLinkType is nothing) then
                                                                Dim LinkType1538 as ENLinkType
                                                                LinkType1538 = LinkedTxnLinkType.GetValue()
                                                        End If
                                                        'Get value of Amount
                                                        Dim Amount1539 as Double
                                                        Amount1539 = LinkedTxnAmount.GetValue()
                                                Next i1533
                                        End If
                                Next i1521
                        End If
                        if (not BillPaymentCheckRet.DataExtRetList is nothing)
                                Dim i16.0 as Integer
                                for i16.0 = 0  to BillPaymentCheckRet.DataExtRetList.Count - 1
                                        Dim DataExtRet as IDataExtRet
                                        DataExtRet = BillPaymentCheckRet.DataExtRetList.GetAt(i16.0)
                                        'Get value of OwnerID
                                        if ( not DataExtRetOwnerID is nothing) then
                                                Dim OwnerID1541 as String
                                                OwnerID1541 = DataExtRetOwnerID.GetValue()
                                        End If
                                        'Get value of DataExtName
                                        Dim DataExtName1542 as String
                                        DataExtName1542 = DataExtRetDataExtName.GetValue()
                                        'Get value of DataExtType
                                        Dim DataExtType1543 as ENDataExtType
                                        DataExtType1543 = DataExtRetDataExtType.GetValue()
                                        'Get value of DataExtValue
                                        Dim DataExtValue1544 as String
                                        DataExtValue1544 = DataExtRetDataExtValue.GetValue()
                                Next i16.0
                        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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
//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  DoBillPaymentCheckQuery()
                {
                        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;

                                BuildBillPaymentCheckQueryRq(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;

                                WalkBillPaymentCheckQueryRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildBillPaymentCheckQueryRq(IMsgSetRequest requestMsgSet)
                {
                        IBillPaymentCheckQuery BillPaymentCheckQueryRq= requestMsgSet.AppendBillPaymentCheckQueryRq();
                        //Set attributes
                        //Set field value for metaData
                        BillPaymentCheckQueryRq.metaData.SetValue("IQBENmetaDataType");
                        //Set field value for iterator
                        BillPaymentCheckQueryRq.iterator.SetValue("IQBENiteratorType");
                        //Set field value for iteratorID
                        BillPaymentCheckQueryRq.iteratorID.SetValue("IQBUUIDType");
                        string ORTxnQueryElementType1411 = "TxnIDList";
                        if (ORTxnQueryElementType1411 == "TxnIDList")
                        {
                                //Set field value for TxnIDList
                                //May create more than one of these if needed
                                BillPaymentCheckQueryRq.ORTxnQuery.TxnIDList.Add("200000-1011023419");
                        }
                        if (ORTxnQueryElementType1411 == "RefNumberList")
                        {
                                //Set field value for RefNumberList
                                //May create more than one of these if needed
                                BillPaymentCheckQueryRq.ORTxnQuery.RefNumberList.Add("ab");
                        }
                        if (ORTxnQueryElementType1411 == "RefNumberCaseSensitiveList")
                        {
                                //Set field value for RefNumberCaseSensitiveList
                                //May create more than one of these if needed
                                BillPaymentCheckQueryRq.ORTxnQuery.RefNumberCaseSensitiveList.Add("ab");
                        }
                        if (ORTxnQueryElementType1411 == "TxnFilter")
                        {
                                //Set field value for MaxReturned
                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.MaxReturned.SetValue(6);
                                string ORDateRangeFilterElementType1412 = "ModifiedDateRangeFilter";
                                if (ORDateRangeFilterElementType1412 == "ModifiedDateRangeFilter")
                                {
                                        //Set field value for FromModifiedDate
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.ModifiedDateRangeFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false);
                                        //Set field value for ToModifiedDate
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.ModifiedDateRangeFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false);
                                }
                                if (ORDateRangeFilterElementType1412 == "TxnDateRangeFilter")
                                {
                                        string ORTxnDateRangeFilterElementType1413 = "TxnDateFilter";
                                        if (ORTxnDateRangeFilterElementType1413 == "TxnDateFilter")
                                        {
                                                //Set field value for FromTxnDate
                                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.TxnDateRangeFilter.ORTxnDateRangeFilter.TxnDateFilter.FromTxnDate.SetValue(DateTime.Parse("12/15/2007"));
                                                //Set field value for ToTxnDate
                                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.TxnDateRangeFilter.ORTxnDateRangeFilter.TxnDateFilter.ToTxnDate.SetValue(DateTime.Parse("12/15/2007"));
                                        }
                                        if (ORTxnDateRangeFilterElementType1413 == "DateMacro")
                                        {
                                                //Set field value for DateMacro
                                                BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORDateRangeFilter.TxnDateRangeFilter.ORTxnDateRangeFilter.DateMacro.SetValue(ENDateMacro.dmAll);
                                        }
                                }
                                string OREntityFilterElementType1414 = "ListIDList";
                                if (OREntityFilterElementType1414 == "ListIDList")
                                {
                                        //Set field value for ListIDList
                                        //May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.ListIDList.Add("200000-1011023419");
                                }
                                if (OREntityFilterElementType1414 == "FullNameList")
                                {
                                        //Set field value for FullNameList
                                        //May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.FullNameList.Add("ab");
                                }
                                if (OREntityFilterElementType1414 == "ListIDWithChildren")
                                {
                                        //Set field value for ListIDWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.ListIDWithChildren.SetValue("200000-1011023419");
                                }
                                if (OREntityFilterElementType1414 == "FullNameWithChildren")
                                {
                                        //Set field value for FullNameWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.EntityFilter.OREntityFilter.FullNameWithChildren.SetValue("ab");
                                }
                                string ORAccountFilterElementType1415 = "ListIDList";
                                if (ORAccountFilterElementType1415 == "ListIDList")
                                {
                                        //Set field value for ListIDList
                                        //May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.ListIDList.Add("200000-1011023419");
                                }
                                if (ORAccountFilterElementType1415 == "FullNameList")
                                {
                                        //Set field value for FullNameList
                                        //May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.FullNameList.Add("ab");
                                }
                                if (ORAccountFilterElementType1415 == "ListIDWithChildren")
                                {
                                        //Set field value for ListIDWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.ListIDWithChildren.SetValue("200000-1011023419");
                                }
                                if (ORAccountFilterElementType1415 == "FullNameWithChildren")
                                {
                                        //Set field value for FullNameWithChildren
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.AccountFilter.ORAccountFilter.FullNameWithChildren.SetValue("ab");
                                }
                                string ORRefNumberFilterElementType1416 = "RefNumberFilter";
                                if (ORRefNumberFilterElementType1416 == "RefNumberFilter")
                                {
                                        //Set field value for MatchCriterion
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith);
                                        //Set field value for RefNumber
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberFilter.RefNumber.SetValue("ab");
                                }
                                if (ORRefNumberFilterElementType1416 == "RefNumberRangeFilter")
                                {
                                        //Set field value for FromRefNumber
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberRangeFilter.FromRefNumber.SetValue("ab");
                                        //Set field value for ToRefNumber
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.ORRefNumberFilter.RefNumberRangeFilter.ToRefNumber.SetValue("ab");
                                }
                                string ORCurrencyFilterElementType1417 = "ListIDList";
                                if (ORCurrencyFilterElementType1417 == "ListIDList")
                                {
                                        //Set field value for ListIDList
                                        //May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.CurrencyFilter.ORCurrencyFilter.ListIDList.Add("200000-1011023419");
                                }
                                if (ORCurrencyFilterElementType1417 == "FullNameList")
                                {
                                        //Set field value for FullNameList
                                        //May create more than one of these if needed
                                        BillPaymentCheckQueryRq.ORTxnQuery.TxnFilter.CurrencyFilter.ORCurrencyFilter.FullNameList.Add("ab");
                                }
                        }
                        //Set field value for IncludeLineItems
                        BillPaymentCheckQueryRq.IncludeLineItems.SetValue(true);
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        BillPaymentCheckQueryRq.IncludeRetElementList.Add("ab");
                        //Set field value for OwnerIDList
                        //May create more than one of these if needed
                        BillPaymentCheckQueryRq.OwnerIDList.Add(Guid.NewGuid().ToString());
                }




                void WalkBillPaymentCheckQueryRs(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.rtBillPaymentCheckQueryRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IBillPaymentCheckRetList BillPaymentCheckRet = (IBillPaymentCheckRetList)response.Detail;
                                                        WalkBillPaymentCheckRet(BillPaymentCheckRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkBillPaymentCheckRet(IBillPaymentCheckRetList BillPaymentCheckRet)
                {
                        if (BillPaymentCheckRet == null) return;
                        //Go through all the elements of IBillPaymentCheckRetList
                        //Get value of TxnID
                        if (BillPaymentCheckRet.TxnID != null)
                        {
                                string TxnID1418 = (string)BillPaymentCheckRet.TxnID.GetValue();
                        }
                        //Get value of TimeCreated
                        if (BillPaymentCheckRet.TimeCreated != null)
                        {
                                DateTime TimeCreated1419 = (DateTime)BillPaymentCheckRet.TimeCreated.GetValue();
                        }
                        //Get value of TimeModified
                        if (BillPaymentCheckRet.TimeModified != null)
                        {
                                DateTime TimeModified1420 = (DateTime)BillPaymentCheckRet.TimeModified.GetValue();
                        }
                        //Get value of EditSequence
                        if (BillPaymentCheckRet.EditSequence != null)
                        {
                                string EditSequence1421 = (string)BillPaymentCheckRet.EditSequence.GetValue();
                        }
                        //Get value of TxnNumber
                        if (BillPaymentCheckRet.TxnNumber != null)
                        {
                                int TxnNumber1422 = (int)BillPaymentCheckRet.TxnNumber.GetValue();
                        }
                        if (BillPaymentCheckRet.PayeeEntityRef != null)
                        {
                                //Get value of ListID
                                if (BillPaymentCheckRet.PayeeEntityRef.ListID != null)
                                {
                                        string ListID1423 = (string)BillPaymentCheckRet.PayeeEntityRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (BillPaymentCheckRet.PayeeEntityRef.FullName != null)
                                {
                                        string FullName1424 = (string)BillPaymentCheckRet.PayeeEntityRef.FullName.GetValue();
                                }
                        }
                        if (BillPaymentCheckRet.APAccountRef != null)
                        {
                                //Get value of ListID
                                if (BillPaymentCheckRet.APAccountRef.ListID != null)
                                {
                                        string ListID1425 = (string)BillPaymentCheckRet.APAccountRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (BillPaymentCheckRet.APAccountRef.FullName != null)
                                {
                                        string FullName1426 = (string)BillPaymentCheckRet.APAccountRef.FullName.GetValue();
                                }
                        }
                        //Get value of TxnDate
                        if (BillPaymentCheckRet.TxnDate != null)
                        {
                                DateTime TxnDate1427 = (DateTime)BillPaymentCheckRet.TxnDate.GetValue();
                        }
                        if (BillPaymentCheckRet.BankAccountRef != null)
                        {
                                //Get value of ListID
                                if (BillPaymentCheckRet.BankAccountRef.ListID != null)
                                {
                                        string ListID1428 = (string)BillPaymentCheckRet.BankAccountRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (BillPaymentCheckRet.BankAccountRef.FullName != null)
                                {
                                        string FullName1429 = (string)BillPaymentCheckRet.BankAccountRef.FullName.GetValue();
                                }
                        }
                        //Get value of Amount
                        if (BillPaymentCheckRet.Amount != null)
                        {
                                double Amount1430 = (double)BillPaymentCheckRet.Amount.GetValue();
                        }
                        if (BillPaymentCheckRet.CurrencyRef != null)
                        {
                                //Get value of ListID
                                if (BillPaymentCheckRet.CurrencyRef.ListID != null)
                                {
                                        string ListID1431 = (string)BillPaymentCheckRet.CurrencyRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (BillPaymentCheckRet.CurrencyRef.FullName != null)
                                {
                                        string FullName1432 = (string)BillPaymentCheckRet.CurrencyRef.FullName.GetValue();
                                }
                        }
                        //Get value of ExchangeRate
                        if (BillPaymentCheckRet.ExchangeRate != null)
                        {
                                IQBFloatType ExchangeRate1433 = (IQBFloatType)BillPaymentCheckRet.ExchangeRate.GetValue();
                        }
                        //Get value of AmountInHomeCurrency
                        if (BillPaymentCheckRet.AmountInHomeCurrency != null)
                        {
                                double AmountInHomeCurrency1434 = (double)BillPaymentCheckRet.AmountInHomeCurrency.GetValue();
                        }
                        //Get value of RefNumber
                        if (BillPaymentCheckRet.RefNumber != null)
                        {
                                string RefNumber1435 = (string)BillPaymentCheckRet.RefNumber.GetValue();
                        }
                        //Get value of Memo
                        if (BillPaymentCheckRet.Memo != null)
                        {
                                string Memo1436 = (string)BillPaymentCheckRet.Memo.GetValue();
                        }
                        if (BillPaymentCheckRet.Address != null)
                        {
                                //Get value of Addr1
                                if (BillPaymentCheckRet.Address.Addr1 != null)
                                {
                                        string Addr11437 = (string)BillPaymentCheckRet.Address.Addr1.GetValue();
                                }
                                //Get value of Addr2
                                if (BillPaymentCheckRet.Address.Addr2 != null)
                                {
                                        string Addr21438 = (string)BillPaymentCheckRet.Address.Addr2.GetValue();
                                }
                                //Get value of Addr3
                                if (BillPaymentCheckRet.Address.Addr3 != null)
                                {
                                        string Addr31439 = (string)BillPaymentCheckRet.Address.Addr3.GetValue();
                                }
                                //Get value of Addr4
                                if (BillPaymentCheckRet.Address.Addr4 != null)
                                {
                                        string Addr41440 = (string)BillPaymentCheckRet.Address.Addr4.GetValue();
                                }
                                //Get value of Addr5
                                if (BillPaymentCheckRet.Address.Addr5 != null)
                                {
                                        string Addr51441 = (string)BillPaymentCheckRet.Address.Addr5.GetValue();
                                }
                                //Get value of City
                                if (BillPaymentCheckRet.Address.City != null)
                                {
                                        string City1442 = (string)BillPaymentCheckRet.Address.City.GetValue();
                                }
                                //Get value of State
                                if (BillPaymentCheckRet.Address.State != null)
                                {
                                        string State1443 = (string)BillPaymentCheckRet.Address.State.GetValue();
                                }
                                //Get value of PostalCode
                                if (BillPaymentCheckRet.Address.PostalCode != null)
                                {
                                        string PostalCode1444 = (string)BillPaymentCheckRet.Address.PostalCode.GetValue();
                                }
                                //Get value of Country
                                if (BillPaymentCheckRet.Address.Country != null)
                                {
                                        string Country1445 = (string)BillPaymentCheckRet.Address.Country.GetValue();
                                }
                                //Get value of Note
                                if (BillPaymentCheckRet.Address.Note != null)
                                {
                                        string Note1446 = (string)BillPaymentCheckRet.Address.Note.GetValue();
                                }
                        }
                        if (BillPaymentCheckRet.AddressBlock != null)
                        {
                                //Get value of Addr1
                                if (BillPaymentCheckRet.AddressBlock.Addr1 != null)
                                {
                                        string Addr11447 = (string)BillPaymentCheckRet.AddressBlock.Addr1.GetValue();
                                }
                                //Get value of Addr2
                                if (BillPaymentCheckRet.AddressBlock.Addr2 != null)
                                {
                                        string Addr21448 = (string)BillPaymentCheckRet.AddressBlock.Addr2.GetValue();
                                }
                                //Get value of Addr3
                                if (BillPaymentCheckRet.AddressBlock.Addr3 != null)
                                {
                                        string Addr31449 = (string)BillPaymentCheckRet.AddressBlock.Addr3.GetValue();
                                }
                                //Get value of Addr4
                                if (BillPaymentCheckRet.AddressBlock.Addr4 != null)
                                {
                                        string Addr41450 = (string)BillPaymentCheckRet.AddressBlock.Addr4.GetValue();
                                }
                                //Get value of Addr5
                                if (BillPaymentCheckRet.AddressBlock.Addr5 != null)
                                {
                                        string Addr51451 = (string)BillPaymentCheckRet.AddressBlock.Addr5.GetValue();
                                }
                        }
                        //Get value of IsToBePrinted
                        if (BillPaymentCheckRet.IsToBePrinted != null)
                        {
                                bool IsToBePrinted1452 = (bool)BillPaymentCheckRet.IsToBePrinted.GetValue();
                        }
                        //Get value of ExternalGUID
                        if (BillPaymentCheckRet.ExternalGUID != null)
                        {
                                string ExternalGUID1453 = (string)BillPaymentCheckRet.ExternalGUID.GetValue();
                        }
                        if (BillPaymentCheckRet.AppliedToTxnRetList != null)
                        {
                                for (int i1454 = 0; i1454 < BillPaymentCheckRet.AppliedToTxnRetList.Count; i1454++)
                                {
                                        IAppliedToTxnRet AppliedToTxnRet = BillPaymentCheckRet.AppliedToTxnRetList.GetAt(i1454);
                                        //Get value of TxnID
                                        string TxnID1455 = (string)AppliedToTxnRet.TxnID.GetValue();
                                        //Get value of TxnType
                                        ENTxnType TxnType1456 = (ENTxnType)AppliedToTxnRet.TxnType.GetValue();
                                        //Get value of TxnDate
                                        if (AppliedToTxnRet.TxnDate != null)
                                        {
                                                DateTime TxnDate1457 = (DateTime)AppliedToTxnRet.TxnDate.GetValue();
                                        }
                                        //Get value of RefNumber
                                        if (AppliedToTxnRet.RefNumber != null)
                                        {
                                                string RefNumber1458 = (string)AppliedToTxnRet.RefNumber.GetValue();
                                        }
                                        //Get value of BalanceRemaining
                                        if (AppliedToTxnRet.BalanceRemaining != null)
                                        {
                                                double BalanceRemaining1459 = (double)AppliedToTxnRet.BalanceRemaining.GetValue();
                                        }
                                        //Get value of Amount
                                        if (AppliedToTxnRet.Amount != null)
                                        {
                                                double Amount1460 = (double)AppliedToTxnRet.Amount.GetValue();
                                        }
                                        //Get value of DiscountAmount
                                        if (AppliedToTxnRet.DiscountAmount != null)
                                        {
                                                double DiscountAmount1461 = (double)AppliedToTxnRet.DiscountAmount.GetValue();
                                        }
                                        if (AppliedToTxnRet.DiscountAccountRef != null)
                                        {
                                                //Get value of ListID
                                                if (AppliedToTxnRet.DiscountAccountRef.ListID != null)
                                                {
                                                        string ListID1462 = (string)AppliedToTxnRet.DiscountAccountRef.ListID.GetValue();
                                                }
                                                //Get value of FullName
                                                if (AppliedToTxnRet.DiscountAccountRef.FullName != null)
                                                {
                                                        string FullName1463 = (string)AppliedToTxnRet.DiscountAccountRef.FullName.GetValue();
                                                }
                                        }
                                        if (AppliedToTxnRet.DiscountClassRef != null)
                                        {
                                                //Get value of ListID
                                                if (AppliedToTxnRet.DiscountClassRef.ListID != null)
                                                {
                                                        string ListID1464 = (string)AppliedToTxnRet.DiscountClassRef.ListID.GetValue();
                                                }
                                                //Get value of FullName
                                                if (AppliedToTxnRet.DiscountClassRef.FullName != null)
                                                {
                                                        string FullName1465 = (string)AppliedToTxnRet.DiscountClassRef.FullName.GetValue();
                                                }
                                        }
                                        if (AppliedToTxnRet.LinkedTxnList != null)
                                        {
                                                for (int i1466 = 0; i1466 < AppliedToTxnRet.LinkedTxnList.Count; i1466++)
                                                {
                                                        ILinkedTxn LinkedTxn = AppliedToTxnRet.LinkedTxnList.GetAt(i1466);
                                                        //Get value of TxnID
                                                        string TxnID1467 = (string)LinkedTxn.TxnID.GetValue();
                                                        //Get value of TxnType
                                                        ENTxnType TxnType1468 = (ENTxnType)LinkedTxn.TxnType.GetValue();
                                                        //Get value of TxnDate
                                                        DateTime TxnDate1469 = (DateTime)LinkedTxn.TxnDate.GetValue();
                                                        //Get value of RefNumber
                                                        if (LinkedTxn.RefNumber != null)
                                                        {
                                                                string RefNumber1470 = (string)LinkedTxn.RefNumber.GetValue();
                                                        }
                                                        //Get value of LinkType
                                                        if (LinkedTxn.LinkType != null)
                                                        {
                                                                ENLinkType LinkType1471 = (ENLinkType)LinkedTxn.LinkType.GetValue();
                                                        }
                                                        //Get value of Amount
                                                        double Amount1472 = (double)LinkedTxn.Amount.GetValue();
                                                }
                                        }
                                }
                        }
                        if (BillPaymentCheckRet.DataExtRetList != null)
                        {
                                for (int i1473 = 0; i1473 < BillPaymentCheckRet.DataExtRetList.Count; i1473++)
                                {
                                        IDataExtRet DataExtRet = BillPaymentCheckRet.DataExtRetList.GetAt(i1473);
                                        //Get value of OwnerID
                                        if (DataExtRet.OwnerID != null)
                                        {
                                                string OwnerID1474 = (string)DataExtRet.OwnerID.GetValue();
                                        }
                                        //Get value of DataExtName
                                        string DataExtName1475 = (string)DataExtRet.DataExtName.GetValue();
                                        //Get value of DataExtType
                                        ENDataExtType DataExtType1476 = (ENDataExtType)DataExtRet.DataExtType.GetValue();
                                        //Get value of DataExtValue
                                        string DataExtValue1477 = (string)DataExtRet.DataExtValue.GetValue();
                                }
                        }
                }




        }
}