Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Altoviz

Scalekit connector
Open markdown

The Altoviz connector lets your AI agent act in each user's Altoviz account. Each user connects their own Altoviz API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
33 · 20 · 733 read20 write7 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Altoviz connection

    In AgentKit > Connections, create an Altoviz connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'altoviz'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Altoviz:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'altoviz_current_user_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Altoviz credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • altoviz_cash_flow_getGet settled, outstanding and projected cash flow, bucketed by period.Read-only

    Get Cash Flow

    Get settled, outstanding and projected cash flow, bucketed by period. Returns income and expenses per period.

    Inputs

    cumulativeboolean
    Return running totals instead of per-bucket values. Example: true.
    fromstring
    First day of the period. Combined with to, takes precedence over year. Example: example.
    periodicitystring
    Bucket size: Daily, Weekly, Monthly (default), Quarterly or Annually. Example: Daily.one of DailyWeeklyMonthlyQuarterlyAnnually
    tostring
    Last day of the period, included. Example: example.
    yearinteger
    Shorthand for a whole calendar year (defaults to the current one). Ignored when a range is given. Example: 1.
  • altoviz_connection_testCheck that the API key works.Read-only

    Test Connection

    Check that the API key works. Returns a greeting with the account name. Run it first to confirm the connection.

    Inputs

    api_versionstring
    API Version. Example: example.
  • altoviz_contact_getGet one contact person by ID.Read-only

    Get Contact

    Get one contact person by ID. Returns the contact's name, company, email, phones and function.

    Inputs

    contact_idintegerrequired
    Altoviz ID of the contact. Example: 123456.
  • altoviz_contacts_listList contact people, with paging, sorting and a text search.Read-only

    List Contacts

    List contact people, with paging, sorting and a text search. Returns each contact's ID, name, company, email, phone and function.

    Inputs

    order_bystring
    Field to sort by. Example: number.
    page_indexinteger
    Page number, starting at 1. Example: 1.
    page_sizeinteger
    Items per page. Example: 50.
    querystring
    Text to search for. Example: Martin.
  • altoviz_current_user_getGet the Altoviz user and company the API key belongs to.Read-only

    Get Current User

    Get the Altoviz user and company the API key belongs to. Returns the user's name, email and company.

    Inputs

    This tool takes no inputs.

  • altoviz_customer_contacts_listList the contact people of a customer.Read-only

    List Customer Contacts

    List the contact people of a customer. Returns each contact's name, email, phone and function.

    Inputs

    customer_idintegerrequired
    Altoviz ID of the customer. Example: 123456.
  • altoviz_customer_findFind a customer by email, number or your internal ID.Read-only

    Find Customer

    Find a customer by email, number or your internal ID. Returns the matching customer. Use altoviz_customers_list to browse or search by name.

    Inputs

    emailstring
    Customer email address. Example: anna.martin@acme.fr.
    internal_idstring
    Your own ID stored in the customer's internal_id. Example: crm-1001.
    numberstring
    Customer number in Altoviz. Example: C00012.
  • altoviz_customer_getGet one customer by Altoviz ID.Read-only

    Get Customer

    Get one customer by Altoviz ID. Returns the customer's details, addresses, billing options and company information.

    Inputs

    customer_idintegerrequired
    Altoviz ID of the customer. Example: 123456.