curl --request POST \
  --url https://qubesync.com/api/v1/connections/{connection_id}/queued_requests \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_json": {
    "version": "13.0",
    "request": {
      "name": "CustomerQueryRq",
      "attributes": {
        "requestID": "1"
      },
      "children": [
        {
          "name": "MaxReturned",
          "text": "100"
        }
      ]
    }
  },
  "webhook_url": "https://example.com/webhooks/qube_sync"
}
'

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "waiting",
    "request_xml": "<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>100</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "page": 1,
    "original_request_id": "550e8400-e29b-41d4-a716-446655440000",
    "iteration_state": "not_applicable",
    "request_types": [
      "CustomerQueryRq"
    ],
    "webhook_state": "not_applicable",
    "request_json": {
      "version": "13.0",
      "request": {
        "name": "CustomerQueryRq",
        "attributes": {
          "requestID": "1"
        },
        "children": [
          {
            "name": "MaxReturned",
            "text": "100"
          }
        ]
      }
    },
    "response_xml": "<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>",
    "response_json": [
      {}
    ],
    "webhook_url": "https://example.com/webhook",
    "webhook_attempts": [
      {
        "status": "succeeded",
        "sent_at": "2023-11-07T05:31:56Z",
        "error": "<string>",
        "attempted_at": "2023-11-07T05:31:56Z",
        "response": "<string>"
      }
    ],
    "webhook_error": "<string>",
    "error": {
      "error_type": "xml_error",
      "message": "<string>",
      "user_message": "<string>",
      "error_code": 123,
      "hresult": "<string>",
      "debug_message": "<string>",
      "code": "<string>",
      "details": {}
    },
    "links": {
      "self": "/api/v1/connections/123e4567-e89b-12d3-a456-426614174000/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "ui": "/app/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "connection_ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000",
      "pages": "/api/v2/connections/123e4567-e89b-12d3-a456-426614174000/queued-requests/550e8400-e29b-41d4-a716-446655440000/pages"
    },
    "inserted_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:01Z"
  }
}

{
  "errors": "unknown parameter: \"emial\""
}

Unauthorized

{
  "errors": {
    "detail": "Not Found"
  }
}

{
  "errors": {
    "webhook_url": [
      "must be an http or https URL"
    ]
  }
}

Queued Requests

Queue a new request

Creates a new queued request for processing by the QuickBooks integration. The QuickBooks request itself can be in either XML (request_xml) or JSON (request_json) format. If a webhook URL is provided, the system will send a POST request to that URL with the result when the request is completed. Only request_xml, request_json and webhook_url can be set: sending state, webhook_state, iteration_state, api_version, response_json, response_xml, webhook_error, webhook_attempts, connection or error is refused with 422 naming the field, and nothing is queued. QuBe Sync sets those as the Web Connector and QuickBooks handle the request.

POST

connections

{connection_id}

queued_requests

curl --request POST \
  --url https://qubesync.com/api/v1/connections/{connection_id}/queued_requests \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_json": {
    "version": "13.0",
    "request": {
      "name": "CustomerQueryRq",
      "attributes": {
        "requestID": "1"
      },
      "children": [
        {
          "name": "MaxReturned",
          "text": "100"
        }
      ]
    }
  },
  "webhook_url": "https://example.com/webhooks/qube_sync"
}
'

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "waiting",
    "request_xml": "<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>100</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "page": 1,
    "original_request_id": "550e8400-e29b-41d4-a716-446655440000",
    "iteration_state": "not_applicable",
    "request_types": [
      "CustomerQueryRq"
    ],
    "webhook_state": "not_applicable",
    "request_json": {
      "version": "13.0",
      "request": {
        "name": "CustomerQueryRq",
        "attributes": {
          "requestID": "1"
        },
        "children": [
          {
            "name": "MaxReturned",
            "text": "100"
          }
        ]
      }
    },
    "response_xml": "<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>",
    "response_json": [
      {}
    ],
    "webhook_url": "https://example.com/webhook",
    "webhook_attempts": [
      {
        "status": "succeeded",
        "sent_at": "2023-11-07T05:31:56Z",
        "error": "<string>",
        "attempted_at": "2023-11-07T05:31:56Z",
        "response": "<string>"
      }
    ],
    "webhook_error": "<string>",
    "error": {
      "error_type": "xml_error",
      "message": "<string>",
      "user_message": "<string>",
      "error_code": 123,
      "hresult": "<string>",
      "debug_message": "<string>",
      "code": "<string>",
      "details": {}
    },
    "links": {
      "self": "/api/v1/connections/123e4567-e89b-12d3-a456-426614174000/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "ui": "/app/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "connection_ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000",
      "pages": "/api/v2/connections/123e4567-e89b-12d3-a456-426614174000/queued-requests/550e8400-e29b-41d4-a716-446655440000/pages"
    },
    "inserted_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:01Z"
  }
}

{
  "errors": "unknown parameter: \"emial\""
}

Unauthorized

{
  "errors": {
    "detail": "Not Found"
  }
}

{
  "errors": {
    "webhook_url": [
      "must be an http or https URL"
    ]
  }
}

Authorizations

Authorization

string

header

required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id

string<uuid>

required

ID of the connection that will process this request

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

request_json

object

The request payload in JSON format (alternative to request_xml)

Example:

{
  "version": "13.0",
  "request": {
    "name": "CustomerQueryRq",
    "attributes": { "requestID": "1" },
    "children": [{ "name": "MaxReturned", "text": "100" }]
  }
}

request_xml

string

The request payload in QBXML format (alternative to request_json)

Example:

"<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>100</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>"

webhook_url

string<uri>

Optional absolute http or https URL to receive a webhook when the request is completed. It may not contain a username or password, and in production it may not point at localhost or a private, loopback or link-local address. A qube listen URL must be one of this app's.

Maximum string length: 2048

Example:

"https://your-webhook-url.com/endpoint"

Response

Queued request created successfully

data

object

Show child attributes

Overview

API v2

API v1 (legacy)

Queue a new request

Authorizations

Path Parameters

Body

Response