Skip to main content
POST
/
sandbox
/
quickbooks
/
{sandbox_id}
/
initialize
Initialize quickbooks sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/quickbooks/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounts": [
    {}
  ],
  "customers": [
    {}
  ],
  "vendors": [
    {}
  ],
  "invoices": [
    {}
  ],
  "payments": [
    {}
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

​
Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

​
sandbox_id
string
required

The unique sandbox identifier

Body

application/json

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
Accounts · object[] | null

List of accounts (input: minimal, output: full API objects)

​
customers
Customers · object[] | null

List of customers (input: minimal, output: full API objects)

​
vendors
Vendors · object[] | null

List of vendors (input: minimal, output: full API objects)

​
invoices
Invoices · object[] | null

List of invoices (input: minimal, output: full API objects)

​
payments
Payments · object[] | null

List of payments (input: minimal, output: full API objects)

Response

Successful Response

Response model for sandbox initialization

​
sandbox_id
string
required

Sandbox identifier

​
status
enum<string>
required

Current status

Available options:
idle,
occupied
​
message
string
required

Initialization result message

​
records_created
Records Created · object

Count of records created per object type