---
title: "Initialize quickbooks sandbox with data"
method: POST
path: "/sandbox/quickbooks/{sandbox_id}/initialize"
tags: ["sandbox"]
---

# Initialize quickbooks sandbox with data

`POST /sandbox/quickbooks/{sandbox_id}/initialize`

## Request

- Base URL: `https://api.klavis.ai`
- URL: `https://api.klavis.ai/sandbox/quickbooks/{sandbox_id}/initialize`
- Auth: HTTP bearer

Initialize the sandbox with quickbooks-specific data following the defined schema.

## Path parameters

- `sandbox_id` string, required: The unique sandbox identifier

## Query parameters

- `init_default_data` boolean: If true, use default test data for initialization

## Request body

- QuickBooksData: Complete QuickBooks sandbox data structure Note: For dump operations, accounts/customers/etc. will contain full API response objects with additional fields beyond the minimal input schema. This is expected behavior.
  - `accounts` object[], nullable: List of accounts (input: minimal, output: full API objects)
  - `customers` object[], nullable: List of customers (input: minimal, output: full API objects)
  - `vendors` object[], nullable: List of vendors (input: minimal, output: full API objects)
  - `invoices` object[], nullable: List of invoices (input: minimal, output: full API objects)
  - `payments` object[], nullable: List of payments (input: minimal, output: full API objects)

## Response `200`

Successful Response

- InitializeSandboxResponse: Response model for sandbox initialization
  - `sandbox_id` string, required: Sandbox identifier
  - `status` 'idle' | 'occupied' | 'error', required: Status of a sandbox instance - matches database enum
  - `message` string, required: Initialization result message

## Other responses

- `422`: Validation Error

## Changes

- **2026-02-09** `522418a391e5`: 1 warning
  - removed the optional property `records_created` from the response with the `200` status
- **2026-02-08** `d70b82139caa`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-01-31** `4457a0cdcfab`: 1 warning
  - added the new `error` enum value to the `status` response property for the response status `200`

[Operation history](https://skmtc.dev/klavis-ai/apis/klavis-ai-https-www-klavis-ai/changes/sandbox/quickbooks/:sandbox_id/initialize/post.md)

---

[API](https://skmtc.dev/klavis-ai/apis/klavis-ai-https-www-klavis-ai.md) - [All operations](https://skmtc.dev/klavis-ai/apis/klavis-ai-https-www-klavis-ai/llms.txt) - [OpenAPI document](https://skmtc.dev/klavis-ai/apis/klavis-ai-https-www-klavis-ai/revisions/1f05ced7280f?raw)
