POST/api/v1/quickbooks/sync/bulk

Run bulk QuickBooks sync

Starts multi-operation bulk sync and returns accepted job payload. Both /api/v1/integrations/quickbooks/* and /api/v1/quickbooks/* map to the same ApiQuickBooksController method (bulkSync). This family is a path alias that binds controller methods directly (for example `export const GET = controller.getAccounts()`) and relies on controller-level error handling.

RBAC · quickbooks

Request body

Content type: application/json · schema QuickBooksV1BulkSyncBody

operationsarray of objectRequired

min items 1 · max items 10

itemsobject

operation_typestringRequired

Enum: customer_syncinvoice_exportinvoice_importpayment_syncitem_synctax_syncfull_synctest_connection

entity_idsarray of string

itemsstring <uuid>

qbo_entity_idsarray of string

itemsstring

date_rangeobject

start_datestringRequired

end_datestringRequired

parametersobject

execution_modestring

Enum: sequentialparallel

stop_on_errorboolean

notification_emailstring <email>

Response body

Success response 202 · schema QuickBooksV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

202

Async sync job accepted.

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/quickbooks/sync/bulk

cURL

curl -X POST "https://algapsa.com/api/v1/quickbooks/sync/bulk" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "operations": [
    {
      "operation_type": "customer_sync",
      "entity_ids": [
        "01HN2K7VRB9PQ3Y0000000000"
      ],
      "qbo_entity_ids": [
        "string"
      ],
      "date_range": {
        "start_date": "string",
        "end_date": "string"
      },
      "parameters": {}
    }
  ],
  "execution_mode": "sequential",
  "stop_on_error": false,
  "notification_email": "user@example.com"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/quickbooks/sync/bulk", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "operations": [
      {
        "operation_type": "customer_sync",
        "entity_ids": [
          "01HN2K7VRB9PQ3Y0000000000"
        ],
        "qbo_entity_ids": [
          "string"
        ],
        "date_range": {
          "start_date": "string",
          "end_date": "string"
        },
        "parameters": {}
      }
    ],
    "execution_mode": "sequential",
    "stop_on_error": false,
    "notification_email": "user@example.com"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/quickbooks/sync/bulk");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""operations"": [
    {
      ""operation_type"": ""customer_sync"",
      ""entity_ids"": [
        ""01HN2K7VRB9PQ3Y0000000000""
      ],
      ""qbo_entity_ids"": [
        ""string""
      ],
      ""date_range"": {
        ""start_date"": ""string"",
        ""end_date"": ""string""
      },
      ""parameters"": {}
    }
  ],
  ""execution_mode"": ""sequential"",
  ""stop_on_error"": false,
  ""notification_email"": ""user@example.com""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

202 OK·application/json

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