> ## Documentation Index
> Fetch the complete documentation index at: https://www.klavis.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Initialize quickbooks sandbox with data

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



## OpenAPI

````yaml post /sandbox/quickbooks/{sandbox_id}/initialize
openapi: 3.1.0
info:
  title: Klavis AI (https://www.klavis.ai)
  description: Klavis AI - Open Source MCP Integrations for AI Applications
  version: 0.1.0
servers:
  - url: https://api.klavis.ai
    description: US Production server
  - url: https://api.eu.klavis.ai
    description: EU Production server
security: []
paths:
  /sandbox/quickbooks/{sandbox_id}/initialize:
    post:
      tags:
        - sandbox
      summary: Initialize quickbooks sandbox with data
      description: >-
        Initialize the sandbox with quickbooks-specific data following the
        defined schema.
      operationId: initialize_sandbox_sandbox_quickbooks__sandbox_id__initialize_post
      parameters:
        - name: sandbox_id
          in: path
          required: true
          schema:
            type: string
            description: The unique sandbox identifier
            title: Sandbox Id
          description: The unique sandbox identifier
        - name: init_default_data
          in: query
          required: false
          schema:
            type: boolean
            description: If true, use default test data for initialization
            default: false
            title: Init Default Data
          description: If true, use default test data for initialization
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/QuickBooksData'
                - type: 'null'
              title: Request Body
            examples:
              default:
                summary: Example initialization data
                value:
                  accounts:
                    - Name: Business Checking Account
                      AccountType: Bank
                    - Name: Savings Account
                      AccountType: Bank
                    - Name: Accounts Receivable
                      AccountType: Accounts Receivable
                    - Name: Sales Revenue
                      AccountType: Income
                    - Name: Consulting Revenue
                      AccountType: Income
                    - Name: Product Sales
                      AccountType: Income
                    - Name: Office Expenses
                      AccountType: Expense
                    - Name: Rent Expense
                      AccountType: Expense
                    - Name: Utilities Expense
                      AccountType: Expense
                    - Name: Marketing Expense
                      AccountType: Expense
                    - Name: Travel Expense
                      AccountType: Expense
                    - Name: Insurance Expense
                      AccountType: Expense
                    - Name: Equipment
                      AccountType: Other Current Asset
                    - Name: Accounts Payable
                      AccountType: Accounts Payable
                    - Name: Sales Tax Payable
                      AccountType: Other Current Liability
                  customers:
                    - DisplayName: Acme Corporation
                      CompanyName: Acme Corporation
                      PrimaryEmailAddr:
                        Address: billing@acme.com
                      BillAddr:
                        Line1: 123 Business Street
                        City: San Francisco
                        CountrySubDivisionCode: CA
                        PostalCode: '94105'
                    - DisplayName: Tech Start Inc
                      CompanyName: Tech Start Inc
                      PrimaryEmailAddr:
                        Address: accounts@techstart.io
                      BillAddr:
                        Line1: 456 Innovation Drive
                        City: Palo Alto
                        CountrySubDivisionCode: CA
                        PostalCode: '94301'
                    - DisplayName: Global Enterprises LLC
                      CompanyName: Global Enterprises LLC
                      PrimaryEmailAddr:
                        Address: finance@globalent.com
                      BillAddr:
                        Line1: 789 Commerce Ave
                        City: New York
                        CountrySubDivisionCode: NY
                        PostalCode: '10001'
                    - DisplayName: Blue Sky Solutions
                      CompanyName: Blue Sky Solutions
                      PrimaryEmailAddr:
                        Address: billing@bluesky.com
                    - DisplayName: Metro Systems Corp
                      CompanyName: Metro Systems Corp
                      PrimaryEmailAddr:
                        Address: ap@metrosystems.com
                    - DisplayName: Sunrise Technologies
                      CompanyName: Sunrise Technologies
                      PrimaryEmailAddr:
                        Address: accounting@sunrise.tech
                    - DisplayName: Pacific Coast Partners
                      CompanyName: Pacific Coast Partners
                      PrimaryEmailAddr:
                        Address: billing@pacificcoast.com
                    - DisplayName: Quantum Dynamics Inc
                      CompanyName: Quantum Dynamics Inc
                      PrimaryEmailAddr:
                        Address: invoices@quantum.com
                    - DisplayName: Silver Lining Consulting
                      CompanyName: Silver Lining Consulting
                      PrimaryEmailAddr:
                        Address: payments@silverlining.co
                    - DisplayName: Mountain View Associates
                      CompanyName: Mountain View Associates
                      PrimaryEmailAddr:
                        Address: finance@mountainview.com
                    - DisplayName: Urban Development Group
                      CompanyName: Urban Development Group
                      PrimaryEmailAddr:
                        Address: billing@urbandev.com
                    - DisplayName: Coastal Innovations
                      CompanyName: Coastal Innovations
                      PrimaryEmailAddr:
                        Address: accounting@coastal.io
                    - DisplayName: Premier Business Services
                      CompanyName: Premier Business Services
                      PrimaryEmailAddr:
                        Address: accounts@premier.biz
                    - DisplayName: NextGen Solutions
                      CompanyName: NextGen Solutions
                      PrimaryEmailAddr:
                        Address: billing@nextgen.com
                    - DisplayName: Digital Horizon Corp
                      CompanyName: Digital Horizon Corp
                      PrimaryEmailAddr:
                        Address: invoicing@digitalhorizon.com
                  vendors:
                    - DisplayName: Office Supply Company
                      CompanyName: Office Supply Company
                    - DisplayName: Cloud Services Provider
                      CompanyName: Cloud Services Provider
                    - DisplayName: Marketing Agency Solutions
                      CompanyName: Marketing Agency Solutions
                    - DisplayName: Legal Services Partners
                      CompanyName: Legal Services Partners
                    - DisplayName: Telecommunications Inc
                      CompanyName: Telecommunications Inc
                    - DisplayName: Equipment Rental Company
                      CompanyName: Equipment Rental Company
                    - DisplayName: Insurance Brokers LLC
                      CompanyName: Insurance Brokers LLC
                    - DisplayName: Property Management Group
                      CompanyName: Property Management Group
                    - DisplayName: IT Services Consultant
                      CompanyName: IT Services Consultant
                    - DisplayName: Accounting Services Co
                      CompanyName: Accounting Services Co
                    - DisplayName: Shipping & Logistics Inc
                      CompanyName: Shipping & Logistics Inc
                    - DisplayName: Web Development Studio
                      CompanyName: Web Development Studio
                    - DisplayName: Facility Maintenance Services
                      CompanyName: Facility Maintenance Services
                    - DisplayName: Professional Training Corp
                      CompanyName: Professional Training Corp
                    - DisplayName: Security Systems Provider
                      CompanyName: Security Systems Provider
                  invoices:
                    - Line:
                        - Amount: 1500
                          DetailType: SalesItemLineDetail
                          Description: Consulting Services - Strategic Planning
                          SalesItemLineDetail:
                            Qty: 10
                            UnitPrice: 150
                    - Line:
                        - Amount: 2500
                          DetailType: SalesItemLineDetail
                          Description: Software Development Services
                          SalesItemLineDetail:
                            Qty: 20
                            UnitPrice: 125
                    - Line:
                        - Amount: 800
                          DetailType: SalesItemLineDetail
                          Description: Monthly Maintenance Agreement
                          SalesItemLineDetail:
                            Qty: 1
                            UnitPrice: 800
                    - Line:
                        - Amount: 3200
                          DetailType: SalesItemLineDetail
                          Description: Custom Application Development
                          SalesItemLineDetail:
                            Qty: 32
                            UnitPrice: 100
                    - Line:
                        - Amount: 1200
                          DetailType: SalesItemLineDetail
                          Description: Project Management Services
                          SalesItemLineDetail:
                            Qty: 12
                            UnitPrice: 100
                    - Line:
                        - Amount: 950
                          DetailType: SalesItemLineDetail
                          Description: Business Analysis and Requirements
                          SalesItemLineDetail:
                            Qty: 10
                            UnitPrice: 95
                    - Line:
                        - Amount: 1800
                          DetailType: SalesItemLineDetail
                          Description: Training and Documentation
                          SalesItemLineDetail:
                            Qty: 18
                            UnitPrice: 100
                    - Line:
                        - Amount: 2200
                          DetailType: SalesItemLineDetail
                          Description: System Integration Services
                          SalesItemLineDetail:
                            Qty: 20
                            UnitPrice: 110
                    - Line:
                        - Amount: 1600
                          DetailType: SalesItemLineDetail
                          Description: Quality Assurance and Testing
                          SalesItemLineDetail:
                            Qty: 16
                            UnitPrice: 100
                    - Line:
                        - Amount: 2800
                          DetailType: SalesItemLineDetail
                          Description: Database Design and Implementation
                          SalesItemLineDetail:
                            Qty: 20
                            UnitPrice: 140
                    - Line:
                        - Amount: 1400
                          DetailType: SalesItemLineDetail
                          Description: Security Audit Services
                          SalesItemLineDetail:
                            Qty: 14
                            UnitPrice: 100
                    - Line:
                        - Amount: 3000
                          DetailType: SalesItemLineDetail
                          Description: Cloud Migration Services
                          SalesItemLineDetail:
                            Qty: 30
                            UnitPrice: 100
                    - Line:
                        - Amount: 1100
                          DetailType: SalesItemLineDetail
                          Description: Performance Optimization
                          SalesItemLineDetail:
                            Qty: 11
                            UnitPrice: 100
                    - Line:
                        - Amount: 2400
                          DetailType: SalesItemLineDetail
                          Description: API Development and Integration
                          SalesItemLineDetail:
                            Qty: 24
                            UnitPrice: 100
                    - Line:
                        - Amount: 1750
                          DetailType: SalesItemLineDetail
                          Description: Mobile Application Development
                          SalesItemLineDetail:
                            Qty: 14
                            UnitPrice: 125
                  payments:
                    - TotalAmt: 1500
                      Line: []
                    - TotalAmt: 2500
                      Line: []
                    - TotalAmt: 800
                      Line: []
                    - TotalAmt: 3200
                      Line: []
                    - TotalAmt: 1200
                      Line: []
                    - TotalAmt: 950
                      Line: []
                    - TotalAmt: 1800
                      Line: []
                    - TotalAmt: 2200
                      Line: []
                    - TotalAmt: 1600
                      Line: []
                    - TotalAmt: 2800
                      Line: []
                    - TotalAmt: 1400
                      Line: []
                    - TotalAmt: 3000
                      Line: []
                    - TotalAmt: 1100
                      Line: []
                    - TotalAmt: 2400
                      Line: []
                    - TotalAmt: 1750
                      Line: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializeSandboxResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    QuickBooksData:
      properties:
        accounts:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Accounts
          description: 'List of accounts (input: minimal, output: full API objects)'
        customers:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Customers
          description: 'List of customers (input: minimal, output: full API objects)'
        vendors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Vendors
          description: 'List of vendors (input: minimal, output: full API objects)'
        invoices:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Invoices
          description: 'List of invoices (input: minimal, output: full API objects)'
        payments:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Payments
          description: 'List of payments (input: minimal, output: full API objects)'
      additionalProperties: true
      type: object
      title: QuickBooksData
      description: >-
        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.
    InitializeSandboxResponse:
      properties:
        sandbox_id:
          type: string
          title: Sandbox Id
          description: Sandbox identifier
        status:
          $ref: '#/components/schemas/SandboxStatus'
          description: Current status
        message:
          type: string
          title: Message
          description: Initialization result message
      type: object
      required:
        - sandbox_id
        - status
        - message
      title: InitializeSandboxResponse
      description: Response model for sandbox initialization
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SandboxStatus:
      type: string
      enum:
        - idle
        - occupied
        - error
      title: SandboxStatus
      description: Status of a sandbox instance - matches database enum
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      description: Your Klavis AI API key.
      scheme: bearer
      x-fern-bearer:
        name: api_key

````