KLklavis-ai
sandbox

Initialize quickbooks sandbox with data

Changed on

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

post/sandbox/quickbooks/{sandbox_id}/initialize

Request

  • Base URL
    https://api.klavis.ai
  • Auth
    HTTP bearer

Path parameters

sandbox_idstring required

The unique sandbox identifier

Query parameters

init_default_databoolean

If true, use default test data for initialization

Request body

accountsobject[] nullable

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

customersobject[] nullable

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

vendorsobject[] nullable

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

invoicesobject[] nullable

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

paymentsobject[] nullable

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

Response

Successful Response

sandbox_idstring required

Sandbox identifier

status'idle' | 'occupied' | 'error' required

Status of a sandbox instance - matches database enum

messagestring required

Initialization result message

Changes

  • 522418a391e5Revision changes
    • warning

      removed the optional property from the response with the status

  • d70b82139caaRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status