NOTE: these messages are for QBWC versions >= 2
These are the SOAP requests and responses that enable one to communicate with QBWC. They are displayed here to for testing purposes. Replace the elements with the given variable type (e.g. "string" with a username in the authenticate example).
If you're new to web services, the requests are from QuickBooks to your web service. The responses are from your web service back to QuickBooks.
I've pretty-printed these examples but QuickBooks will reject them unless the extra whitespace is removed. Use this to remove extra whitespace:
$output = preg_replace('/[\s+]{2,}/', '', $input);
Prompts the web service to authenticate the specified user and specify the company to be used in the session.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/authenticate"
<?xml version="1.0" encoding="utf-8"?>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
Optional callback allows the web service to evaluate the current web connector version and react to it. Not currently required to support backward compatibility but strongly recommended.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/clientVersion"
<?xml version="1.0" encoding="utf-8"?>
Response:
...missing...
Tells your web service that the web connector is finished with the update session.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/closeConnection"
<?xml version="1.0" encoding="utf-8"?>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
Tells your web service about an error the web connector encountered in its attempt to connect to QuickBooks or QuickBooks POS.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/connectionError"
<?xml version="1.0" encoding="utf-8"?>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
Allows your web service to return the last web service error, normally for display to the user, before causing the update action to stop.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/getLastError"
<?xml version="1.0" encoding="utf-8"?>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
Returns the data request response from QuickBooks or QuickBooks POS.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/receiveResponseXML"
<?xml version="1.0" encoding="utf-8"?>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
The web connector’s invitation to the web service to send a request.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/sendRequestXML"
<?xml version="1.0" encoding="utf-8"?>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
Provides a way for web-service to notify QBWC of it’s version.
Request:
POST /example.com/example.php HTTP/1.1
Host: example.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://developer.intuit.com/serverVersion"
<?xml version="1.0" encoding="utf-8"?>
Response:
...missing...