batchrequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-batchrequest-schema.json",
  "title": "batchrequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-batch-api-openapi.yml#/components/schemas/batchrequest",
  "type": "object",
  "properties": {
    "BatchItemRequest": {
      "allOf": [
        {
          "$ref": "#/$defs/batchitemrequest"
        }
      ],
      "description": "A wrapper around all request objects for this batch operation.",
      "x-intuit-required": "Required"
    }
  },
  "required": [
    "BatchItemRequest"
  ],
  "$defs": {
    "batchitemrequest": {
      "type": "object",
      "title": "batchitemrequest",
      "properties": {
        "optionsData": {
          "type": "string",
          "description": "Use for the void operation for those resources that support it. Must be supplied with operation set to update.\nValid value: void. Required for void operations.",
          "x-intuit-required": "Conditionally required"
        },
        "bId": {
          "type": "string",
          "description": "Unique identifier for the batch item.",
          "x-intuit-required": "Required"
        },
        "Query": {
          "type": "string",
          "description": "The SELECT statement for the query. When Query is defined, do not define the operation attribute.",
          "x-intuit-required": "Optional"
        },
        "operation": {
          "type": "string",
          "description": "The operation to perform with the supplied request object payload. Do not use if this  batchitemrequest object is for a query operation.\nValid values include: create, update, delete Required for create, update, and delete.",
          "x-intuit-required": "Conditionally required"
        },
        "resourceName": {
          "type": "object",
          "x-intuit-type": "Request object",
          "description": "The payload for the request for create, update, and delete operations.",
          "x-intuit-required": "Optional"
        }
      },
      "required": [
        "bId"
      ]
    }
  }
}