Service enabling QuickBooks Web Connector to communicate with OvalEdge
Description: Register a QuickBooks connection configuration
When to use: Call this before QBWC authenticates to register connection details
Example Request:
{
"connectionId": 1234,
"serverType": "quickbooks-desktop",
"additionalAttributes": {
"QB_USERNAME": "Admin",
"QB_PASSWORD": "password",
"QB_COMPANY_FILE_PATH": "C:\\path\\to\\file.qbw"
}
}
Description: Execute a QBXML request and wait for response
When to use: Send QBXML queries/requests to QuickBooks via Web Connector
Example Request:
{
"username": "Admin",
"qbxmlRequest": "... ",
"requestId": "my-request-123",
"timeoutSeconds": 180
}
Description: Check if there's an active QBWC session for a username
When to use: Verify if QuickBooks Web Connector is connected and authenticated
Example: /api/v1/qbwc/session/status/Admin
POST /api/v1/qbwc/registerConnectionGET /api/v1/qbwc/session/status/{username}POST /api/v1/qbwc/executeQBXML