🚀 OvalEdge QBWC Service

Service enabling QuickBooks Web Connector to communicate with OvalEdge

Version 1.0.0-SNAPSHOT
Status ● Running
Timestamp 2025-12-24 10:58:07

🔗 Quick Links

📚 API Endpoints

POST /api/v1/qbwc/registerConnection

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"
  }
}

POST /api/v1/qbwc/executeQBXML

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
}

GET /api/v1/qbwc/session/status/{username}

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

📖 Usage Flow

  1. Register connection: POST /api/v1/qbwc/registerConnection
  2. Start QuickBooks Web Connector and click 'Update Selected'
  3. Check session status: GET /api/v1/qbwc/session/status/{username}
  4. Execute QBXML requests: POST /api/v1/qbwc/executeQBXML