POST/api/v1/integrations/quickbooks/connection/test

Run QuickBooks connection test

Runs connection diagnostics against configured QuickBooks tenant. Both /api/v1/integrations/quickbooks/* and /api/v1/quickbooks/* map to the same ApiQuickBooksController method (testConnection). This family uses route handlers that instantiate ApiQuickBooksController and usually wrap calls in explicit try/catch handleApiError blocks.

RBAC · quickbooks

Request body

Content type: application/json · schema QuickBooksV1ConnectionTestBody

testTypestring

Enum: clientInfoitemscustomersfull

forceRefreshboolean

Response body

Success response 200 · schema QuickBooksV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

QuickBooks operation succeeded.

400

Validation or request parsing failure.

401

API key missing/invalid or associated user missing.

403

QuickBooks RBAC permission denied.

500

Unexpected QuickBooks endpoint failure.

POST /api/v1/integrations/quickbooks/connection/test

cURL

curl -X POST "https://algapsa.com/api/v1/integrations/quickbooks/connection/test" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "testType": "clientInfo",
  "forceRefresh": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/integrations/quickbooks/connection/test", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "testType": "clientInfo",
    "forceRefresh": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/integrations/quickbooks/connection/test");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""testType"": ""clientInfo"",
  ""forceRefresh"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}