ReceivePaymentQuery(1.1)

Queries for the specified receive payment or set of payments.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

IReceivePaymentQuery

Queries for the specified receive payment or set of payments.
     1.1  

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

Queries for the specified receive payment or set of payments.
     1.1  

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

 IReceivePaymentRetList      

(List

of IReceivePaymentRet 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      

CustomerRef

The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A CustomerRef aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a CustomerRef aggregate includes both FullName and ListID, FullName will be ignored. Special cases to note:In SalesReceipt and ReceivePayment requests, CustomerRef refers to the customer or customer job to which the payment is credited.In a TimeTracking request, CustomerRef refers to the customer or customer job to which this time could be billed. If IsBillable is set to true, CustomerRef is required in TimeTrackingAdd. In an ExpenseLineAdd request, if AccountRef refers to an A/P account, CustomerRef must refer to a vendor (not to a customer). If AccountRef refers to any other type of account, the CustomerRef must refer to a customer.
 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    

ARAccountRef

Refers to an accounts receivable account in the QuickBooks file. (The AccountType of this account will be AccountsReceivable.) If an ARAccountRef aggregate includes both FullName and ListID, FullName will be ignored. If this field is in a transaction that links to other transactions, make sure this ARAccountRef matches the ARAccountRef used in the other transactions. For example, in an ARRefundCreditCard transaction, the ARAccountRef of the credit card refund transaction must match the ARAccountRef used in each of the linked credit transactions.
 IQBBaseRef      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 159 chars    

TxnDate

The date of the transaction. In some cases, if you leave TxnDate out of an -Add message, QuickBooks will prefill TxnDate with the date of the last-saved transaction of the same type.
 IQBDateType      

RefNumber

A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a BillPaymentCheckAdd request, if you want to set the check number, use RefNumber.Note (especially relevant to CheckAdd requests): When RefNumber is left blank in an SDK transaction add request (that is, or ), the RefNumber will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no RefNumber had been provided. This is especially relevant to CheckAdd requests because with the current behavior, you will not know the number until the check is printed.
 IQBStringType 20 chars    

TotalAmount

Total amount of money received. For ReceivePaymentAdd, the sum of the PaymentAmount amounts (in the AppliedToTxnAdd aggregates that are included) cannot be greater than the TotalAmount, or you will receive an error.
 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  

TotalAmountInHomeCurrency

Total amount of money paid or received in the home currency.
 IQBAmountType   8.0  

PaymentMethodRef

A customer’s payment method, for example, cash, check, or Master Card. A PaymentMethodRef aggregate refers to an item on the PaymentMethod list. In a request, if a PaymentMethodRef aggregate includes both FullName and ListID, FullName will be ignored. In a SalesReceiptAdd, ReceivePaymentAdd, or ARRefundCreditCard request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type.
 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 31 chars    

Memo

The beginning of this memo will appear in reports that show details of this receive payment.
 IQBStringType 4095 chars    

DepositToAccountRef

Refers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this is not included in the request. In a request, if a DepositToAccountRef 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    

CreditCardTxnInfo

Contains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction. The data following the element CreditCardTxnInputInfo” data is the data from the original qbmsXML request. The “CreditCardTxnResultInfo” is the data from the original qbmsXML response.
 ICreditCardTxnInfo   4.1  

CreditCardTxnInputInfo

This contains data originally supplied in the QBMS transaction request. This information block should not be used in CreditMemo requests for QuickBooks 2007 and new versions. Instead, use the ARRefundCreditCard request.
 ICreditCardTxnInputInfo     Y

CreditCardNumber

Credit-card number for this customer or this payment. Beginning with qbXML spec 6.0 and QuickBooks 2007, you must mask the credit card number with lower case “x” and no dashes. For example, xxxxxxxxxxxx1234.
 IQBStringType 25 chars   Y

ExpirationMonth

The month when the credit card expires.
 IQBIntType 12 chars   Y

ExpirationYear

The year when the credit card expires.
 IQBIntType     Y

NameOnCard

The name on the customer’s credit card.
 IQBStringType 41 chars   Y

CreditCardAddress

The address associated with this credit card.
 IQBStringType 41 chars    

CreditCardPostalCode

The postal code associated with the address for this credit card.
 IQBStringType 18 chars    

CommercialCardCode

This optional field is used only for Visa and Master Card commercial cards. There are three types of these cards: purchase, corporate, and business. Normally, special lower transaction fee rates apply when these cards are used and this field is filled out. If this field is left blank, then the usual (and higher) discount rate applies.
 IQBStringType 24 chars    

TransactionMode

Indicates whether this transaction came from a card swipe (tmCardPresent) or not (tmCardNotPresent).
 IQBENTransactionModeType   6.0  

CreditCardTxnType

Indicates the QBMS transaction from which the current transaction data originated, for example, Charge, Authorization, Capture, Refund, VoiceAuthorization, or Void.
 IQBENCreditCardTxnTypeType   7.0  

CreditCardTxnResultInfo

This contains data returned in the QBMS transaction response. This information block should not be used in CreditMemo requests for QuickBooks 2007 and new versions. Instead, use the ARRefundCreditCard request.
 ICreditCardTxnResultInfo     Y

ResultCode

This contains the status code returned in the original QBMS transaction response.
 IQBIntType     Y

ResultMessage

This contains the status message returned in the original QBMS transaction response.
 IQBStringType 60 chars   Y

CreditCardTransID

This transaction ID is returned from the credit card processor. You should save this value for any possible QBMS SDK transaction requests that need it, for example, CustomerCreditCardTxnVoidRq, or CustomerCreditCardCaptureRq. You should also save this transaction ID and include it in the QB SDK SalesReceiptAdd or ReceivePaymentAdd requests if you are intending to save the transaction data in QuickBooks.
 IQBStringType 24 chars   Y

MerchantAccountNumber

This is the QBMS account number of the merchant who is running the transaction using the customer’s credit card. It is returned from the transaction request and should be stored for subsequent transactions, such as using it in the QB SDK SalesReceiptAdd, ReceivePaymentAdd, ARRefundCreditCard requests to save the transaction data in QuickBooks.
 IQBStringType 32 chars   Y

AuthorizationCode

The authorization code is returned from the credit card processor to indicate that the charge will be paid by the card issuer. In a voice authorization request (CustomerCreditCardVoiceAuthRq), the authorization code is supplied by the card issuer over the telephone.
 IQBStringType 12 chars    

AVSStreet

This field contains the value avssPass if the street address supplied in the transaction request matches the customer’s address on file at the card issuer. It contains the value avssFail if there is not a match, or avssNotAvailable if the card issuer does not support AVS. Note: This field was required in qbXML 4.1, but is optional in qbXML 5.0 and later.
 IQBENAVSStreetType      

AVSZip

This field contains the value avszPass if the customer postal ZIP code supplied in the transaction request matches the customer’s postal code recognized at the card issuer. It contains the value avszFail if there is not a match, or avszNotAvailable if the card issuer does not support AVS. Note: This field was required in qbXML 4.1, but is optional in qbXML 5.0 and later.
 IQBENAVSZipType      

CardSecurityCodeMatch

This field contains the value Pass if the card security code supplied in the transaction request matches the card security code recognized for that credit card number at the card issuer. It contains the value Fail if there is not a match.
 IQBENCardSecurityCodeMatchType   6.0  

ReconBatchID

This value is returned by QBMS from the transaction request, and is used internally by the QuickBooks/QBMS Recon (reconcile) feature. You should save this value without modification and include it in the QB SDK SalesReceiptAdd or ReceivePaymentAdd requests if you want to save the transaction data in QuickBooks.
 IQBStringType 84 chars    

PaymentGroupingCode

Internal code needed for the QuickBooks reconciliation feature, if integrating with QuickBooks. This value is returned in the QBMS response to a QBMS transaction request, and must be subsequently supplied by your application in the QB SDK ReceivePaymentAdd or SalesReceiptAdd request.
 IQBIntType      

PaymentStatus

Indicates whether the transaction is known to have been successfully processed by the card issuer, with the value “psCompleted” indicating success. That is, there was a response sent to QBMS and from QBMS to the application indicating success. The value “psUnknown” indicates that such a response was not received. If “Unknown” is returned, the transaction may have been successfully or unsuccessfully processed at the card issuer: there simply was no response (possibly due to network errors).
 IQBENPaymentStatusType     Y

TxnAuthorizationTime

Timestamp indicating the time in which the card processor authorized the transaction.
 IQBDateTimeType     Y

TxnAuthorizationStamp

This value is used to support the credit card transaction Reconcile feature within QuickBooks.
 IQBIntType      

ClientTransID

This value is returned from QBMS transactions for future use by the QuickBooks Reconciliation feature.
 IQBStringType 16 chars 6.0  

UnusedPayment

ReceivePaymentRet will include an unused payment in cases such as these:The sum of the PaymentAmount amounts is less than TotalAmount.A payment is received for the exact amount of an invoice, but a credit or a discount (or both) are set.
 IQBAmountType      

UnusedCredits

ReceivePaymentRet will include an unused credit if the AppliedAmount of a SetCredit aggregate is less than the amount of credit available for the specified CreditTxnID.
 IQBAmountType      

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   2.0  

(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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="17.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <ReceivePaymentQueryRq 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 -->
                </ReceivePaymentQueryRq>

                <ReceivePaymentQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE" iteratorRemainingCount="INTTYPE" iteratorID="UUIDTYPE">
                        <ReceivePaymentRet> <!-- optional, may repeat -->
                                <TxnID >IDTYPE</TxnID> <!-- optional -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- optional -->
                                <EditSequence >STRTYPE</EditSequence> <!-- optional -->
                                <TxnNumber >INTTYPE</TxnNumber> <!-- optional -->
                                <CustomerRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </CustomerRef>
                                <ARAccountRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ARAccountRef>
                                <TxnDate >DATETYPE</TxnDate> <!-- optional -->
                                <RefNumber >STRTYPE</RefNumber> <!-- optional -->
                                <TotalAmount >AMTTYPE</TotalAmount> <!-- optional -->
                                <CurrencyRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </CurrencyRef>
                                <ExchangeRate >FLOATTYPE</ExchangeRate> <!-- optional -->
                                <TotalAmountInHomeCurrency >AMTTYPE</TotalAmountInHomeCurrency> <!-- optional -->
                                <PaymentMethodRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </PaymentMethodRef>
                                <Memo >STRTYPE</Memo> <!-- optional -->
                                <DepositToAccountRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </DepositToAccountRef>
                                <CreditCardTxnInfo> <!-- optional -->
                                        <CreditCardTxnInputInfo> <!-- required -->
                                                <CreditCardNumber >STRTYPE</CreditCardNumber> <!-- required -->
                                                <ExpirationMonth >INTTYPE</ExpirationMonth> <!-- required -->
                                                <ExpirationYear >INTTYPE</ExpirationYear> <!-- required -->
                                                <NameOnCard >STRTYPE</NameOnCard> <!-- required -->
                                                <CreditCardAddress >STRTYPE</CreditCardAddress> <!-- optional -->
                                                <CreditCardPostalCode >STRTYPE</CreditCardPostalCode> <!-- optional -->
                                                <CommercialCardCode >STRTYPE</CommercialCardCode> <!-- optional -->
                                                <!-- TransactionMode may have one of the following values: CardNotPresent [DEFAULT], CardPresent -->
                                                <TransactionMode >ENUMTYPE</TransactionMode> <!-- optional -->
                                                <!-- CreditCardTxnType may have one of the following values: Authorization, Capture, Charge, Refund, VoiceAuthorization -->
                                                <CreditCardTxnType >ENUMTYPE</CreditCardTxnType> <!-- optional -->
                                        </CreditCardTxnInputInfo>
                                        <CreditCardTxnResultInfo> <!-- required -->
                                                <ResultCode >INTTYPE</ResultCode> <!-- required -->
                                                <ResultMessage >STRTYPE</ResultMessage> <!-- required -->
                                                <CreditCardTransID >STRTYPE</CreditCardTransID> <!-- required -->
                                                <MerchantAccountNumber >STRTYPE</MerchantAccountNumber> <!-- required -->
                                                <AuthorizationCode >STRTYPE</AuthorizationCode> <!-- optional -->
                                                <!-- AVSStreet may have one of the following values: Pass, Fail, NotAvailable -->
                                                <AVSStreet >ENUMTYPE</AVSStreet> <!-- optional -->
                                                <!-- AVSZip may have one of the following values: Pass, Fail, NotAvailable -->
                                                <AVSZip >ENUMTYPE</AVSZip> <!-- optional -->
                                                <!-- CardSecurityCodeMatch may have one of the following values: Pass, Fail, NotAvailable -->
                                                <CardSecurityCodeMatch >ENUMTYPE</CardSecurityCodeMatch> <!-- optional -->
                                                <ReconBatchID >STRTYPE</ReconBatchID> <!-- optional -->
                                                <PaymentGroupingCode >INTTYPE</PaymentGroupingCode> <!-- optional -->
                                                <!-- PaymentStatus may have one of the following values: Unknown, Completed -->
                                                <PaymentStatus >ENUMTYPE</PaymentStatus> <!-- required -->
                                                <TxnAuthorizationTime >DATETIMETYPE</TxnAuthorizationTime> <!-- required -->
                                                <TxnAuthorizationStamp >INTTYPE</TxnAuthorizationStamp> <!-- optional -->
                                                <ClientTransID >STRTYPE</ClientTransID> <!-- optional -->
                                        </CreditCardTxnResultInfo>
                                </CreditCardTxnInfo>
                                <UnusedPayment >AMTTYPE</UnusedPayment> <!-- optional -->
                                <UnusedCredits >AMTTYPE</UnusedCredits> <!-- 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>
                        </ReceivePaymentRet>
                </ReceivePaymentQueryRs>
        </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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
'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  DoReceivePaymentQuery()
                        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

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

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




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




                Public Sub WalkReceivePaymentRet(ReceivePaymentRet as IReceivePaymentRetList)
                        if (ReceivePaymentRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IReceivePaymentRetList
                        'Get value of TxnID
                        if ( not ReceivePaymentRet.TxnID is nothing) then
                                Dim TxnID18922 as String
                                TxnID18922 = ReceivePaymentRet.TxnID.GetValue()
                        End If
                        'Get value of TimeCreated
                        if ( not ReceivePaymentRet.TimeCreated is nothing) then
                                Dim TimeCreated18923 as DateTime
                                TimeCreated18923 = ReceivePaymentRet.TimeCreated.GetValue()
                        End If
                        'Get value of TimeModified
                        if ( not ReceivePaymentRet.TimeModified is nothing) then
                                Dim TimeModified18924 as DateTime
                                TimeModified18924 = ReceivePaymentRet.TimeModified.GetValue()
                        End If
                        'Get value of EditSequence
                        if ( not ReceivePaymentRet.EditSequence is nothing) then
                                Dim EditSequence18925 as String
                                EditSequence18925 = ReceivePaymentRet.EditSequence.GetValue()
                        End If
                        'Get value of TxnNumber
                        if ( not ReceivePaymentRet.TxnNumber is nothing) then
                                Dim TxnNumber18926 as Integer
                                TxnNumber18926 = ReceivePaymentRet.TxnNumber.GetValue()
                        End If
                        if (not ReceivePaymentRet.CustomerRef. is nothing) then
                                'Get value of ListID
                                if ( not ReceivePaymentRet.CustomerRef.ListID is nothing) then
                                        Dim ListID18927 as String
                                        ListID18927 = ReceivePaymentRet.CustomerRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ReceivePaymentRet.CustomerRef.FullName is nothing) then
                                        Dim FullName18928 as String
                                        FullName18928 = ReceivePaymentRet.CustomerRef.FullName.GetValue()
                                End If
                        End If
                        if (not ReceivePaymentRet.ARAccountRef. is nothing) then
                                'Get value of ListID
                                if ( not ReceivePaymentRet.ARAccountRef.ListID is nothing) then
                                        Dim ListID18929 as String
                                        ListID18929 = ReceivePaymentRet.ARAccountRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ReceivePaymentRet.ARAccountRef.FullName is nothing) then
                                        Dim FullName18930 as String
                                        FullName18930 = ReceivePaymentRet.ARAccountRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of TxnDate
                        if ( not ReceivePaymentRet.TxnDate is nothing) then
                                Dim TxnDate18931 as DateTime
                                TxnDate18931 = ReceivePaymentRet.TxnDate.GetValue()
                        End If
                        'Get value of RefNumber
                        if ( not ReceivePaymentRet.RefNumber is nothing) then
                                Dim RefNumber18932 as String
                                RefNumber18932 = ReceivePaymentRet.RefNumber.GetValue()
                        End If
                        'Get value of TotalAmount
                        if ( not ReceivePaymentRet.TotalAmount is nothing) then
                                Dim TotalAmount18933 as Double
                                TotalAmount18933 = ReceivePaymentRet.TotalAmount.GetValue()
                        End If
                        if (not ReceivePaymentRet.CurrencyRef. is nothing) then
                                'Get value of ListID
                                if ( not ReceivePaymentRet.CurrencyRef.ListID is nothing) then
                                        Dim ListID18934 as String
                                        ListID18934 = ReceivePaymentRet.CurrencyRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ReceivePaymentRet.CurrencyRef.FullName is nothing) then
                                        Dim FullName18935 as String
                                        FullName18935 = ReceivePaymentRet.CurrencyRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of ExchangeRate
                        if ( not ReceivePaymentRet.ExchangeRate is nothing) then
                                Dim ExchangeRate18936 as IQBFloatType
                                ExchangeRate18936 = ReceivePaymentRet.ExchangeRate.GetValue()
                        End If
                        'Get value of TotalAmountInHomeCurrency
                        if ( not ReceivePaymentRet.TotalAmountInHomeCurrency is nothing) then
                                Dim TotalAmountInHomeCurrency18937 as Double
                                TotalAmountInHomeCurrency18937 = ReceivePaymentRet.TotalAmountInHomeCurrency.GetValue()
                        End If
                        if (not ReceivePaymentRet.PaymentMethodRef. is nothing) then
                                'Get value of ListID
                                if ( not ReceivePaymentRet.PaymentMethodRef.ListID is nothing) then
                                        Dim ListID18938 as String
                                        ListID18938 = ReceivePaymentRet.PaymentMethodRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ReceivePaymentRet.PaymentMethodRef.FullName is nothing) then
                                        Dim FullName18939 as String
                                        FullName18939 = ReceivePaymentRet.PaymentMethodRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of Memo
                        if ( not ReceivePaymentRet.Memo is nothing) then
                                Dim Memo18940 as String
                                Memo18940 = ReceivePaymentRet.Memo.GetValue()
                        End If
                        if (not ReceivePaymentRet.DepositToAccountRef. is nothing) then
                                'Get value of ListID
                                if ( not ReceivePaymentRet.DepositToAccountRef.ListID is nothing) then
                                        Dim ListID18941 as String
                                        ListID18941 = ReceivePaymentRet.DepositToAccountRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ReceivePaymentRet.DepositToAccountRef.FullName is nothing) then
                                        Dim FullName18942 as String
                                        FullName18942 = ReceivePaymentRet.DepositToAccountRef.FullName.GetValue()
                                End If
                        End If
                        if (not ReceivePaymentRet.CreditCardTxnInfo. is nothing) then
                                'Get value of CreditCardNumber
                                Dim CreditCardNumber18943 as String
                                CreditCardNumber18943 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardNumber.GetValue()
                                'Get value of ExpirationMonth
                                Dim ExpirationMonth18944 as Integer
                                ExpirationMonth18944 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.ExpirationMonth.GetValue()
                                'Get value of ExpirationYear
                                Dim ExpirationYear18945 as Integer
                                ExpirationYear18945 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.ExpirationYear.GetValue()
                                'Get value of NameOnCard
                                Dim NameOnCard18946 as String
                                NameOnCard18946 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.NameOnCard.GetValue()
                                'Get value of CreditCardAddress
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardAddress is nothing) then
                                        Dim CreditCardAddress18947 as String
                                        CreditCardAddress18947 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardAddress.GetValue()
                                End If
                                'Get value of CreditCardPostalCode
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardPostalCode is nothing) then
                                        Dim CreditCardPostalCode18948 as String
                                        CreditCardPostalCode18948 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardPostalCode.GetValue()
                                End If
                                'Get value of CommercialCardCode
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CommercialCardCode is nothing) then
                                        Dim CommercialCardCode18949 as String
                                        CommercialCardCode18949 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CommercialCardCode.GetValue()
                                End If
                                'Get value of TransactionMode
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.TransactionMode is nothing) then
                                        Dim TransactionMode18950 as ENTransactionMode
                                        TransactionMode18950 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.TransactionMode.GetValue()
                                End If
                                'Get value of CreditCardTxnType
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardTxnType is nothing) then
                                        Dim CreditCardTxnType18951 as ENCreditCardTxnType
                                        CreditCardTxnType18951 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardTxnType.GetValue()
                                End If
                                'Get value of ResultCode
                                Dim ResultCode18952 as Integer
                                ResultCode18952 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ResultCode.GetValue()
                                'Get value of ResultMessage
                                Dim ResultMessage18953 as String
                                ResultMessage18953 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ResultMessage.GetValue()
                                'Get value of CreditCardTransID
                                Dim CreditCardTransID18954 as String
                                CreditCardTransID18954 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.CreditCardTransID.GetValue()
                                'Get value of MerchantAccountNumber
                                Dim MerchantAccountNumber18955 as String
                                MerchantAccountNumber18955 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.MerchantAccountNumber.GetValue()
                                'Get value of AuthorizationCode
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AuthorizationCode is nothing) then
                                        Dim AuthorizationCode18956 as String
                                        AuthorizationCode18956 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AuthorizationCode.GetValue()
                                End If
                                'Get value of AVSStreet
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSStreet is nothing) then
                                        Dim AVSStreet18957 as ENAVSStreet
                                        AVSStreet18957 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSStreet.GetValue()
                                End If
                                'Get value of AVSZip
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSZip is nothing) then
                                        Dim AVSZip18958 as ENAVSZip
                                        AVSZip18958 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSZip.GetValue()
                                End If
                                'Get value of CardSecurityCodeMatch
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.CardSecurityCodeMatch is nothing) then
                                        Dim CardSecurityCodeMatch18959 as ENCardSecurityCodeMatch
                                        CardSecurityCodeMatch18959 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.CardSecurityCodeMatch.GetValue()
                                End If
                                'Get value of ReconBatchID
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ReconBatchID is nothing) then
                                        Dim ReconBatchID18960 as String
                                        ReconBatchID18960 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ReconBatchID.GetValue()
                                End If
                                'Get value of PaymentGroupingCode
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.PaymentGroupingCode is nothing) then
                                        Dim PaymentGroupingCode18961 as Integer
                                        PaymentGroupingCode18961 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.PaymentGroupingCode.GetValue()
                                End If
                                'Get value of PaymentStatus
                                Dim PaymentStatus18962 as ENPaymentStatus
                                PaymentStatus18962 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.PaymentStatus.GetValue()
                                'Get value of TxnAuthorizationTime
                                Dim TxnAuthorizationTime18963 as DateTime
                                TxnAuthorizationTime18963 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.TxnAuthorizationTime.GetValue()
                                'Get value of TxnAuthorizationStamp
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.TxnAuthorizationStamp is nothing) then
                                        Dim TxnAuthorizationStamp18964 as Integer
                                        TxnAuthorizationStamp18964 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.TxnAuthorizationStamp.GetValue()
                                End If
                                'Get value of ClientTransID
                                if ( not ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ClientTransID is nothing) then
                                        Dim ClientTransID18965 as String
                                        ClientTransID18965 = ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ClientTransID.GetValue()
                                End If
                        End If
                        'Get value of UnusedPayment
                        if ( not ReceivePaymentRet.UnusedPayment is nothing) then
                                Dim UnusedPayment18966 as Double
                                UnusedPayment18966 = ReceivePaymentRet.UnusedPayment.GetValue()
                        End If
                        'Get value of UnusedCredits
                        if ( not ReceivePaymentRet.UnusedCredits is nothing) then
                                Dim UnusedCredits18967 as Double
                                UnusedCredits18967 = ReceivePaymentRet.UnusedCredits.GetValue()
                        End If
                        'Get value of ExternalGUID
                        if ( not ReceivePaymentRet.ExternalGUID is nothing) then
                                Dim ExternalGUID18968 as String
                                ExternalGUID18968 = ReceivePaymentRet.ExternalGUID.GetValue()
                        End If
                        if (not ReceivePaymentRet.AppliedToTxnRetList is nothing)
                                Dim i18969 as Integer
                                for i18969 = 0  to ReceivePaymentRet.AppliedToTxnRetList.Count - 1
                                        Dim AppliedToTxnRet as IAppliedToTxnRet
                                        AppliedToTxnRet = ReceivePaymentRet.AppliedToTxnRetList.GetAt(i18969)
                                        'Get value of TxnID
                                        Dim TxnID18970 as String
                                        TxnID18970 = AppliedToTxnRetTxnID.GetValue()
                                        'Get value of TxnType
                                        Dim TxnType18971 as ENTxnType
                                        TxnType18971 = AppliedToTxnRetTxnType.GetValue()
                                        'Get value of TxnDate
                                        if ( not AppliedToTxnRetTxnDate is nothing) then
                                                Dim TxnDate18972 as DateTime
                                                TxnDate18972 = AppliedToTxnRetTxnDate.GetValue()
                                        End If
                                        'Get value of RefNumber
                                        if ( not AppliedToTxnRetRefNumber is nothing) then
                                                Dim RefNumber18973 as String
                                                RefNumber18973 = AppliedToTxnRetRefNumber.GetValue()
                                        End If
                                        'Get value of BalanceRemaining
                                        if ( not AppliedToTxnRetBalanceRemaining is nothing) then
                                                Dim BalanceRemaining18974 as Double
                                                BalanceRemaining18974 = AppliedToTxnRetBalanceRemaining.GetValue()
                                        End If
                                        'Get value of Amount
                                        if ( not AppliedToTxnRetAmount is nothing) then
                                                Dim Amount18975 as Double
                                                Amount18975 = AppliedToTxnRetAmount.GetValue()
                                        End If
                                        'Get value of DiscountAmount
                                        if ( not AppliedToTxnRetDiscountAmount is nothing) then
                                                Dim DiscountAmount18976 as Double
                                                DiscountAmount18976 = AppliedToTxnRetDiscountAmount.GetValue()
                                        End If
                                        if (not AppliedToTxnRetDiscountAccountRef. is nothing) then
                                                'Get value of ListID
                                                if ( not AppliedToTxnRetDiscountAccountRef.ListID is nothing) then
                                                        Dim ListID18977 as String
                                                        ListID18977 = AppliedToTxnRetDiscountAccountRef.ListID.GetValue()
                                                End If
                                                'Get value of FullName
                                                if ( not AppliedToTxnRetDiscountAccountRef.FullName is nothing) then
                                                        Dim FullName18978 as String
                                                        FullName18978 = 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 ListID18979 as String
                                                        ListID18979 = AppliedToTxnRetDiscountClassRef.ListID.GetValue()
                                                End If
                                                'Get value of FullName
                                                if ( not AppliedToTxnRetDiscountClassRef.FullName is nothing) then
                                                        Dim FullName18980 as String
                                                        FullName18980 = AppliedToTxnRetDiscountClassRef.FullName.GetValue()
                                                End If
                                        End If
                                        if (not AppliedToTxnRetLinkedTxnList is nothing)
                                                Dim i18981 as Integer
                                                for i18981 = 0  to AppliedToTxnRetLinkedTxnList.Count - 1
                                                        Dim LinkedTxn as ILinkedTxn
                                                        LinkedTxn = AppliedToTxnRetLinkedTxnList.GetAt(i18981)
                                                        'Get value of TxnID
                                                        Dim TxnID18982 as String
                                                        TxnID18982 = LinkedTxnTxnID.GetValue()
                                                        'Get value of TxnType
                                                        Dim TxnType18983 as ENTxnType
                                                        TxnType18983 = LinkedTxnTxnType.GetValue()
                                                        'Get value of TxnDate
                                                        Dim TxnDate18984 as DateTime
                                                        TxnDate18984 = LinkedTxnTxnDate.GetValue()
                                                        'Get value of RefNumber
                                                        if ( not LinkedTxnRefNumber is nothing) then
                                                                Dim RefNumber18985 as String
                                                                RefNumber18985 = LinkedTxnRefNumber.GetValue()
                                                        End If
                                                        'Get value of LinkType
                                                        if ( not LinkedTxnLinkType is nothing) then
                                                                Dim LinkType18986 as ENLinkType
                                                                LinkType18986 = LinkedTxnLinkType.GetValue()
                                                        End If
                                                        'Get value of Amount
                                                        Dim Amount18987 as Double
                                                        Amount18987 = LinkedTxnAmount.GetValue()
                                                Next i18981
                                        End If
                                Next i18969
                        End If
                        if (not ReceivePaymentRet.DataExtRetList is nothing)
                                Dim i18988 as Integer
                                for i18988 = 0  to ReceivePaymentRet.DataExtRetList.Count - 1
                                        Dim DataExtRet as IDataExtRet
                                        DataExtRet = ReceivePaymentRet.DataExtRetList.GetAt(i18988)
                                        'Get value of OwnerID
                                        if ( not DataExtRetOwnerID is nothing) then
                                                Dim OwnerID18989 as String
                                                OwnerID18989 = DataExtRetOwnerID.GetValue()
                                        End If
                                        'Get value of DataExtName
                                        Dim DataExtName18990 as String
                                        DataExtName18990 = DataExtRetDataExtName.GetValue()
                                        'Get value of DataExtType
                                        Dim DataExtType18991 as ENDataExtType
                                        DataExtType18991 = DataExtRetDataExtType.GetValue()
                                        'Get value of DataExtValue
                                        Dim DataExtValue18992 as String
                                        DataExtValue18992 = DataExtRetDataExtValue.GetValue()
                                Next i18988
                        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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
//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  DoReceivePaymentQuery()
                {
                        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;

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

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




                void WalkReceivePaymentQueryRs(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.rtReceivePaymentQueryRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IReceivePaymentRetList ReceivePaymentRet = (IReceivePaymentRetList)response.Detail;
                                                        WalkReceivePaymentRet(ReceivePaymentRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkReceivePaymentRet(IReceivePaymentRetList ReceivePaymentRet)
                {
                        if (ReceivePaymentRet == null) return;
                        //Go through all the elements of IReceivePaymentRetList
                        //Get value of TxnID
                        if (ReceivePaymentRet.TxnID != null)
                        {
                                string TxnID18844 = (string)ReceivePaymentRet.TxnID.GetValue();
                        }
                        //Get value of TimeCreated
                        if (ReceivePaymentRet.TimeCreated != null)
                        {
                                DateTime TimeCreated18845 = (DateTime)ReceivePaymentRet.TimeCreated.GetValue();
                        }
                        //Get value of TimeModified
                        if (ReceivePaymentRet.TimeModified != null)
                        {
                                DateTime TimeModified18846 = (DateTime)ReceivePaymentRet.TimeModified.GetValue();
                        }
                        //Get value of EditSequence
                        if (ReceivePaymentRet.EditSequence != null)
                        {
                                string EditSequence18847 = (string)ReceivePaymentRet.EditSequence.GetValue();
                        }
                        //Get value of TxnNumber
                        if (ReceivePaymentRet.TxnNumber != null)
                        {
                                int TxnNumber18848 = (int)ReceivePaymentRet.TxnNumber.GetValue();
                        }
                        if (ReceivePaymentRet.CustomerRef != null)
                        {
                                //Get value of ListID
                                if (ReceivePaymentRet.CustomerRef.ListID != null)
                                {
                                        string ListID18849 = (string)ReceivePaymentRet.CustomerRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ReceivePaymentRet.CustomerRef.FullName != null)
                                {
                                        string FullName18850 = (string)ReceivePaymentRet.CustomerRef.FullName.GetValue();
                                }
                        }
                        if (ReceivePaymentRet.ARAccountRef != null)
                        {
                                //Get value of ListID
                                if (ReceivePaymentRet.ARAccountRef.ListID != null)
                                {
                                        string ListID18851 = (string)ReceivePaymentRet.ARAccountRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ReceivePaymentRet.ARAccountRef.FullName != null)
                                {
                                        string FullName18852 = (string)ReceivePaymentRet.ARAccountRef.FullName.GetValue();
                                }
                        }
                        //Get value of TxnDate
                        if (ReceivePaymentRet.TxnDate != null)
                        {
                                DateTime TxnDate18853 = (DateTime)ReceivePaymentRet.TxnDate.GetValue();
                        }
                        //Get value of RefNumber
                        if (ReceivePaymentRet.RefNumber != null)
                        {
                                string RefNumber18854 = (string)ReceivePaymentRet.RefNumber.GetValue();
                        }
                        //Get value of TotalAmount
                        if (ReceivePaymentRet.TotalAmount != null)
                        {
                                double TotalAmount18855 = (double)ReceivePaymentRet.TotalAmount.GetValue();
                        }
                        if (ReceivePaymentRet.CurrencyRef != null)
                        {
                                //Get value of ListID
                                if (ReceivePaymentRet.CurrencyRef.ListID != null)
                                {
                                        string ListID18856 = (string)ReceivePaymentRet.CurrencyRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ReceivePaymentRet.CurrencyRef.FullName != null)
                                {
                                        string FullName18857 = (string)ReceivePaymentRet.CurrencyRef.FullName.GetValue();
                                }
                        }
                        //Get value of ExchangeRate
                        if (ReceivePaymentRet.ExchangeRate != null)
                        {
                                IQBFloatType ExchangeRate18858 = (IQBFloatType)ReceivePaymentRet.ExchangeRate.GetValue();
                        }
                        //Get value of TotalAmountInHomeCurrency
                        if (ReceivePaymentRet.TotalAmountInHomeCurrency != null)
                        {
                                double TotalAmountInHomeCurrency18859 = (double)ReceivePaymentRet.TotalAmountInHomeCurrency.GetValue();
                        }
                        if (ReceivePaymentRet.PaymentMethodRef != null)
                        {
                                //Get value of ListID
                                if (ReceivePaymentRet.PaymentMethodRef.ListID != null)
                                {
                                        string ListID18860 = (string)ReceivePaymentRet.PaymentMethodRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ReceivePaymentRet.PaymentMethodRef.FullName != null)
                                {
                                        string FullName18861 = (string)ReceivePaymentRet.PaymentMethodRef.FullName.GetValue();
                                }
                        }
                        //Get value of Memo
                        if (ReceivePaymentRet.Memo != null)
                        {
                                string Memo18862 = (string)ReceivePaymentRet.Memo.GetValue();
                        }
                        if (ReceivePaymentRet.DepositToAccountRef != null)
                        {
                                //Get value of ListID
                                if (ReceivePaymentRet.DepositToAccountRef.ListID != null)
                                {
                                        string ListID18863 = (string)ReceivePaymentRet.DepositToAccountRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ReceivePaymentRet.DepositToAccountRef.FullName != null)
                                {
                                        string FullName18864 = (string)ReceivePaymentRet.DepositToAccountRef.FullName.GetValue();
                                }
                        }
                        if (ReceivePaymentRet.CreditCardTxnInfo != null)
                        {
                                //Get value of CreditCardNumber
                                string CreditCardNumber18865 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardNumber.GetValue();
                                //Get value of ExpirationMonth
                                int ExpirationMonth18866 = (int)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.ExpirationMonth.GetValue();
                                //Get value of ExpirationYear
                                int ExpirationYear18867 = (int)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.ExpirationYear.GetValue();
                                //Get value of NameOnCard
                                string NameOnCard18868 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.NameOnCard.GetValue();
                                //Get value of CreditCardAddress
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardAddress != null)
                                {
                                        string CreditCardAddress18869 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardAddress.GetValue();
                                }
                                //Get value of CreditCardPostalCode
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardPostalCode != null)
                                {
                                        string CreditCardPostalCode18870 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardPostalCode.GetValue();
                                }
                                //Get value of CommercialCardCode
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CommercialCardCode != null)
                                {
                                        string CommercialCardCode18871 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CommercialCardCode.GetValue();
                                }
                                //Get value of TransactionMode
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.TransactionMode != null)
                                {
                                        ENTransactionMode TransactionMode18872 = (ENTransactionMode)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.TransactionMode.GetValue();
                                }
                                //Get value of CreditCardTxnType
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardTxnType != null)
                                {
                                        ENCreditCardTxnType CreditCardTxnType18873 = (ENCreditCardTxnType)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnInputInfo.CreditCardTxnType.GetValue();
                                }
                                //Get value of ResultCode
                                int ResultCode18874 = (int)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ResultCode.GetValue();
                                //Get value of ResultMessage
                                string ResultMessage18875 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ResultMessage.GetValue();
                                //Get value of CreditCardTransID
                                string CreditCardTransID18876 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.CreditCardTransID.GetValue();
                                //Get value of MerchantAccountNumber
                                string MerchantAccountNumber18877 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.MerchantAccountNumber.GetValue();
                                //Get value of AuthorizationCode
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AuthorizationCode != null)
                                {
                                        string AuthorizationCode18878 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AuthorizationCode.GetValue();
                                }
                                //Get value of AVSStreet
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSStreet != null)
                                {
                                        ENAVSStreet AVSStreet18879 = (ENAVSStreet)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSStreet.GetValue();
                                }
                                //Get value of AVSZip
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSZip != null)
                                {
                                        ENAVSZip AVSZip18880 = (ENAVSZip)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.AVSZip.GetValue();
                                }
                                //Get value of CardSecurityCodeMatch
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.CardSecurityCodeMatch != null)
                                {
                                        ENCardSecurityCodeMatch CardSecurityCodeMatch18881 = (ENCardSecurityCodeMatch)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.CardSecurityCodeMatch.GetValue();
                                }
                                //Get value of ReconBatchID
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ReconBatchID != null)
                                {
                                        string ReconBatchID18882 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ReconBatchID.GetValue();
                                }
                                //Get value of PaymentGroupingCode
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.PaymentGroupingCode != null)
                                {
                                        int PaymentGroupingCode18883 = (int)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.PaymentGroupingCode.GetValue();
                                }
                                //Get value of PaymentStatus
                                ENPaymentStatus PaymentStatus18884 = (ENPaymentStatus)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.PaymentStatus.GetValue();
                                //Get value of TxnAuthorizationTime
                                DateTime TxnAuthorizationTime18885 = (DateTime)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.TxnAuthorizationTime.GetValue();
                                //Get value of TxnAuthorizationStamp
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.TxnAuthorizationStamp != null)
                                {
                                        int TxnAuthorizationStamp18886 = (int)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.TxnAuthorizationStamp.GetValue();
                                }
                                //Get value of ClientTransID
                                if (ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ClientTransID != null)
                                {
                                        string ClientTransID18887 = (string)ReceivePaymentRet.CreditCardTxnInfo.CreditCardTxnResultInfo.ClientTransID.GetValue();
                                }
                        }
                        //Get value of UnusedPayment
                        if (ReceivePaymentRet.UnusedPayment != null)
                        {
                                double UnusedPayment18888 = (double)ReceivePaymentRet.UnusedPayment.GetValue();
                        }
                        //Get value of UnusedCredits
                        if (ReceivePaymentRet.UnusedCredits != null)
                        {
                                double UnusedCredits18889 = (double)ReceivePaymentRet.UnusedCredits.GetValue();
                        }
                        //Get value of ExternalGUID
                        if (ReceivePaymentRet.ExternalGUID != null)
                        {
                                string ExternalGUID18890 = (string)ReceivePaymentRet.ExternalGUID.GetValue();
                        }
                        if (ReceivePaymentRet.AppliedToTxnRetList != null)
                        {
                                for (int i18891 = 0; i18891 < ReceivePaymentRet.AppliedToTxnRetList.Count; i18891++)
                                {
                                        IAppliedToTxnRet AppliedToTxnRet = ReceivePaymentRet.AppliedToTxnRetList.GetAt(i18891);
                                        //Get value of TxnID
                                        string TxnID18892 = (string)AppliedToTxnRet.TxnID.GetValue();
                                        //Get value of TxnType
                                        ENTxnType TxnType18893 = (ENTxnType)AppliedToTxnRet.TxnType.GetValue();
                                        //Get value of TxnDate
                                        if (AppliedToTxnRet.TxnDate != null)
                                        {
                                                DateTime TxnDate18894 = (DateTime)AppliedToTxnRet.TxnDate.GetValue();
                                        }
                                        //Get value of RefNumber
                                        if (AppliedToTxnRet.RefNumber != null)
                                        {
                                                string RefNumber18895 = (string)AppliedToTxnRet.RefNumber.GetValue();
                                        }
                                        //Get value of BalanceRemaining
                                        if (AppliedToTxnRet.BalanceRemaining != null)
                                        {
                                                double BalanceRemaining18896 = (double)AppliedToTxnRet.BalanceRemaining.GetValue();
                                        }
                                        //Get value of Amount
                                        if (AppliedToTxnRet.Amount != null)
                                        {
                                                double Amount18897 = (double)AppliedToTxnRet.Amount.GetValue();
                                        }
                                        //Get value of DiscountAmount
                                        if (AppliedToTxnRet.DiscountAmount != null)
                                        {
                                                double DiscountAmount18898 = (double)AppliedToTxnRet.DiscountAmount.GetValue();
                                        }
                                        if (AppliedToTxnRet.DiscountAccountRef != null)
                                        {
                                                //Get value of ListID
                                                if (AppliedToTxnRet.DiscountAccountRef.ListID != null)
                                                {
                                                        string ListID18899 = (string)AppliedToTxnRet.DiscountAccountRef.ListID.GetValue();
                                                }
                                                //Get value of FullName
                                                if (AppliedToTxnRet.DiscountAccountRef.FullName != null)
                                                {
                                                        string FullName18900 = (string)AppliedToTxnRet.DiscountAccountRef.FullName.GetValue();
                                                }
                                        }
                                        if (AppliedToTxnRet.DiscountClassRef != null)
                                        {
                                                //Get value of ListID
                                                if (AppliedToTxnRet.DiscountClassRef.ListID != null)
                                                {
                                                        string ListID18901 = (string)AppliedToTxnRet.DiscountClassRef.ListID.GetValue();
                                                }
                                                //Get value of FullName
                                                if (AppliedToTxnRet.DiscountClassRef.FullName != null)
                                                {
                                                        string FullName18902 = (string)AppliedToTxnRet.DiscountClassRef.FullName.GetValue();
                                                }
                                        }
                                        if (AppliedToTxnRet.LinkedTxnList != null)
                                        {
                                                for (int i18903 = 0; i18903 < AppliedToTxnRet.LinkedTxnList.Count; i18903++)
                                                {
                                                        ILinkedTxn LinkedTxn = AppliedToTxnRet.LinkedTxnList.GetAt(i18903);
                                                        //Get value of TxnID
                                                        string TxnID18904 = (string)LinkedTxn.TxnID.GetValue();
                                                        //Get value of TxnType
                                                        ENTxnType TxnType18905 = (ENTxnType)LinkedTxn.TxnType.GetValue();
                                                        //Get value of TxnDate
                                                        DateTime TxnDate18906 = (DateTime)LinkedTxn.TxnDate.GetValue();
                                                        //Get value of RefNumber
                                                        if (LinkedTxn.RefNumber != null)
                                                        {
                                                                string RefNumber18907 = (string)LinkedTxn.RefNumber.GetValue();
                                                        }
                                                        //Get value of LinkType
                                                        if (LinkedTxn.LinkType != null)
                                                        {
                                                                ENLinkType LinkType18908 = (ENLinkType)LinkedTxn.LinkType.GetValue();
                                                        }
                                                        //Get value of Amount
                                                        double Amount18909 = (double)LinkedTxn.Amount.GetValue();
                                                }
                                        }
                                }
                        }
                        if (ReceivePaymentRet.DataExtRetList != null)
                        {
                                for (int i18910 = 0; i18910 < ReceivePaymentRet.DataExtRetList.Count; i18910++)
                                {
                                        IDataExtRet DataExtRet = ReceivePaymentRet.DataExtRetList.GetAt(i18910);
                                        //Get value of OwnerID
                                        if (DataExtRet.OwnerID != null)
                                        {
                                                string OwnerID18911 = (string)DataExtRet.OwnerID.GetValue();
                                        }
                                        //Get value of DataExtName
                                        string DataExtName18912 = (string)DataExtRet.DataExtName.GetValue();
                                        //Get value of DataExtType
                                        ENDataExtType DataExtType18913 = (ENDataExtType)DataExtRet.DataExtType.GetValue();
                                        //Get value of DataExtValue
                                        string DataExtValue18914 = (string)DataExtRet.DataExtValue.GetValue();
                                }
                        }
                }




        }
}