QBXML Message Information

The QBXMLMsgs Message Set

The attributes described in the following table are used in the QBXMLMsgsRq and QBXMLMsgsRs messages, for example:

<QBXMLMsgsRq
oldMessageSetID = “STRTYPE”
newMessageSetID = “STRTYPE”
responseData = “ENUMTYPE”
onError = “ENUMTYPE”>
. . .
<QBXMLMsgsRs
newMessageSetID = “STRTYPE”
messageSetStatusCode = “INTTYPE”>

Attributes in QBXMLMsgs
Attribute Restrictions Meaning
oldMessageSetID Optional; max. 23 characters Identifies the last message set that was sent with error recovery enabled.
Important: If you want to clear ALL of the recovery records for an application, specify the value ClearAllMessageSets (oldMessageSetID = ClearAllMessageSets)
newMessageSetID Optional; max. 23 characters Enables error recovery for the current request message set and identifies the message set.
responseData Optional; default is includeAll Specifies how much of the response to include:
includeAll–The normal response will be returned.
includeNone–The response will include status information but no data.
onError Required; rollbackOnError is not valid and will produce an error Specifies how QuickBooks is to proceed if an error occurs in processing the current request:
stopOnError–Stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition.
continueOnError–Continue processing the remaining requests if an error occurs.
messageSetStatusCode Will only appear if error-recovery attributes were included in the message set request. Gives the status of the entire request message that was set in the QBXMLMsgsRq request. (The status of individual requests within the message set are given by the statusCode, statusSeverity, and statusMessage attributes, which are described below.)

Object Request and Response Messages

The attributes described in the following table are used in object request and response messages, for example:

<AccountAddRq
requestID = “UUIDTYPE”>
. . .
<AccountAddRs
requestID = “UUIDTYPE”
statusCode = “INTTYPE”
statusSeverity = “STRTYPE”
statusMessage = “STRTYPE”>

Attributes in Request and Response Messages
Attribute Restrictions Meaning
requestID Optional If you include a requestID value in an object request message, QuickBooks will return it unchanged as the requestID in the corresponding response message.
statusCode Required A number that corresponds to a statusSeverity and statusMessage. For details about the possible statusCode values that can be returned, see the error list.
statusSeverity Required 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.
statusMessage Required An 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 error list.

Query Request and Response Messages

The attributes described in the following table are used in query request and response messages, for example:

<AccountQueryRq
requestID = “UUIDTYPE”>

metaData = “metaDataType”>
. . .
<AccountQueryRs
retCount = “STRINGTYPE”
requestID = “UUIDTYPE”
statusCode = “INTTYPE”
statusSeverity = “STRTYPE”
statusMessage = “STRTYPE”>

Attributes in Query Requests and Responses
Attribute Restrictions Meaning
iterator Optional Specified in the query request. iterator can be one of these values: Start, Continue, Stop. See the QB SDK Programmer’s Guide for details on use.
iteratorID Optional Specified in queries that use iterators, and returned in the query response.
iteratorRemainingCount Optional Returned in the response to a query using iterators. Indicates the number of objects left to iterate through.
metaData Optional If you specify metaData to be returned in a query request message, QuickBooks will return a retCount containing the approximate 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.) 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.
requestID Optional If you include a requestID value in an object request message, QuickBooks will return it unchanged as the requestID in the corresponding response message.
retCount Optional If you specify metaData to be returned in a query request message, QuickBooks will return the retCount containing the approximate count of the objects that could be expected to be returned from the 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.
statusCode Required A number that corresponds to a statusSeverity and statusMessage. For details about the possible statusCode values that can be returned, see the error list.
statusSeverity Required 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.
statusMessage Required An 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 error list.