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
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Altoviz connection
In AgentKit > Connections, create an Altoviz connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'altoviz'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'altoviz_current_user_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "altoviz"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Altoviz:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="altoviz_current_user_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolaltoviz_cash_flow_getGet settled, outstanding and projected cash flow, bucketed by period.Read-onlyGet 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-onlyTest 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-onlyGet 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-onlyList 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-onlyGet 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-onlyList 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-onlyFind 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-onlyGet 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.
altoviz_customer_get_by_internal_idGet a customer by the ID your own system stored in internal_id.Read-onlyGet Customer by Internal ID
Get a customer by the ID your own system stored in internal_id. Returns the customer, or 404 if none matches. Use it to sync with a CRM without a mapping table.
Inputs
internal_idstringrequired- Your own ID stored in the record's internal_id field. Example: crm-1001.
altoviz_customers_listList customers, with paging, sorting and a text search.Read-onlyList Customers
List customers, with paging, sorting and a text search. Returns each customer's ID, number, name, email, phone, type and addresses. Use altoviz_customer_find to look one up by email, number or internal ID.
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: Acme.
altoviz_product_families_listList product families.Read-onlyList Product Families
List product families. Returns each family's ID, number and label.
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- query (full text search). Example: example.
altoviz_product_findFind a product by number or your internal ID.Read-onlyFind Product
Find a product by number or your internal ID. Returns the matching product.
Inputs
internal_idstring- Your own ID stored in the product's internal_id. Example: sku-cons.
numberstring- Product number. Example: P-CONS.
altoviz_product_getGet one product by Altoviz ID.Read-onlyGet Product
Get one product by Altoviz ID. Returns the product's name, prices, VAT, unit and family.
Inputs
product_idintegerrequired- Altoviz ID of the product. Example: 123456.
altoviz_products_listList products and services in the catalogue, with paging, sorting and a text search.Read-onlyList Products
List products and services in the catalogue, with paging, sorting and a text search. Returns each product's ID, number, name, prices, VAT and unit.
Inputs
family_idstring- Family ID. Example: 1234567890.
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: Consulting.
altoviz_receipts_listList customer payments received (receipts), with paging.Read-onlyList Receipts
List customer payments received (receipts), with paging. Returns each receipt's ID, customer, amount, date, method and linked invoices.
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- query (full text search). Example: example.
altoviz_sales_credit_getGet one sales credit note by ID.Read-onlyGet Credit Note
Get one sales credit note by ID. Returns the credit note's customer, lines, totals and status.
Inputs
sales_credit_idintegerrequired- Altoviz ID of the sales credit. Example: 123456.
altoviz_sales_credits_listList sales credit notes, with filters and paging.Read-onlyList Credit Notes
List sales credit notes, with filters and paging. Returns each credit note's ID, number, customer, date, amounts and status.
Inputs
cancelledstring- Cancelled credits: Excluded (default, when omitted) hides them, Only returns just cancelled credits, All returns both. Example: Only.one of
OnlyExcludedAll customer_idinteger- Only credit notes of this customer. Example: 123456.
fromstring- Only credit notes dated on or after this date, YYYY-MM-DD. Example: 2026-01-01.
order_bystring- Field to sort by. Example: number.
page_indexinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Items per page. Example: 50.
processedstring- Processed credits — those whose terminal e-invoicing status was taken into account ("traitées"): Excluded (default, when omitted) hides them, Only returns just processed credits, All returns both. Example: Only.one of
OnlyExcludedAll tostring- Only credit notes dated on or before this date, YYYY-MM-DD. Example: 2026-12-31.
altoviz_sales_invoice_einvoicing_checkCheck a draft sales invoice against the e-invoicing rules before finalizing.Read-onlyCheck E-Invoicing Compliance
Check a draft sales invoice against the e-invoicing rules before finalizing. Returns the problems found, if any.
Inputs
sales_invoice_idintegerrequired- Altoviz ID of the sales invoice. Example: 123456.
altoviz_sales_invoice_findFind sales invoices by number or your internal ID.Read-onlyFind Sales Invoice
Find sales invoices by number or your internal ID. Returns the matching invoices.
Inputs
internal_idstring- Your own ID stored in the invoice's internal_id. Example: crm-inv-1001.
numberstring- Invoice number. Example: F2026-0042.
altoviz_sales_invoice_getGet one sales invoice by ID.Read-onlyGet Sales Invoice
Get one sales invoice by ID. Returns the invoice's customer, lines, totals, VAT breakdown, balance, status and PDF link.
Inputs
sales_invoice_idintegerrequired- Altoviz ID of the sales invoice. Example: 123456.
altoviz_sales_invoices_listList sales invoices, with filters by date, customer and status, and paging.Read-onlyList Sales Invoices
List sales invoices, with filters by date, customer and status, and paging. Returns each invoice's ID, number, customer, date, amounts, balance and status. Use altoviz_sales_invoice_get for the lines.
Inputs
cancelledstring- Cancelled invoices: Excluded (default) hides them, Only returns just cancelled invoices, All returns both. Example: Excluded.one of
OnlyExcludedAll customer_idinteger- Only invoices of this customer. Example: 123456.
fromstring- Only invoices dated on or after this date, YYYY-MM-DD. Example: 2026-01-01.
order_bystring- Field to sort by. Example: number.
page_indexinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Items per page. Example: 50.
processedstring- Processed (e-invoicing terminal status) invoices: Excluded (default), Only or All. Example: Excluded.one of
OnlyExcludedAll statusstring- Status. Example: Draft.one of
DraftIncomingExpiredPaidToSend tostring- Only invoices dated on or before this date, YYYY-MM-DD. Example: 2026-12-31.
altoviz_sales_quote_getGet one sales quote by ID.Read-onlyGet Sales Quote
Get one sales quote by ID. Returns the quote's customer, lines, totals, validity date and status.
Inputs
sales_quote_idintegerrequired- Altoviz ID of the sales quote. Example: 123456.
altoviz_sales_quotes_listList sales quotes, with filters and paging.Read-onlyList Sales Quotes
List sales quotes, with filters and paging. Returns each quote's ID, number, customer, date, amounts and status.
Inputs
customer_idinteger- Only quotes of this customer. Example: 123456.
fromstring- Only quotes dated on or after this date, YYYY-MM-DD. Example: 2026-01-01.
order_bystring- Field to sort by. Example: number.
page_indexinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Items per page. Example: 50.
status_customer_idinteger- Customer ID. Example: 1.
status_fromstring- From. Example: example.
status_status_customer_idinteger- Customer ID. Example: 1.
status_status_fromstring- From. Example: example.
status_status_statusobject- Status. Example: {}.
status_status_tostring- To. Example: example.
status_tostring- To. Example: example.
tostring- Only quotes dated on or before this date, YYYY-MM-DD. Example: 2026-12-31.
altoviz_settings_getGet the company's Altoviz settings, such as numbering, currency, VAT and payment terms.Read-onlyGet Settings
Get the company's Altoviz settings, such as numbering, currency, VAT and payment terms. Returns the settings object.
Inputs
This tool takes no inputs.
altoviz_supplier_findFind a supplier by email.Read-onlyFind Supplier
Find a supplier by email. Returns the matching supplier.
Inputs
emailstring- Supplier email address. Example: billing@supplier.fr.
internal_idstring- Supplier internal ID. Example: crm-1001.
altoviz_supplier_getGet one supplier by Altoviz ID.Read-onlyGet Supplier
Get one supplier by Altoviz ID. Returns the supplier's details and addresses.
Inputs
supplier_idintegerrequired- Altoviz ID of the supplier. Example: 123456.
altoviz_suppliers_listList suppliers, with paging, sorting and a text search.Read-onlyList Suppliers
List suppliers, with paging, sorting and a text search. Returns each supplier's ID, number, name, email and addresses.
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: Office.
altoviz_top_overdue_customers_getList customers with overdue payments, ranked by amount outstanding.Read-onlyGet Top Overdue Customers
List customers with overdue payments, ranked by amount outstanding. Returns each customer with overdue amount and days.
Inputs
takeinteger- How many customers to return (1–20, defaults to 5). Example: 1.
altoviz_turnover_evolution_getGet turnover over a period, bucketed by month or another periodicity, optionally compared with the previous period and filtered by customer, supplier, colleague or product.Read-onlyGet Turnover Evolution
Get turnover over a period, bucketed by month or another periodicity, optionally compared with the previous period and filtered by customer, supplier, colleague or product. Returns the turnover series and totals.
Inputs
colleague_idinteger- Filter by colleague ID. Example: 11.
compareinteger- Number of previous periods to return alongside, each one calendar year further back (0–2, defaults to 0). Example: 1.
cumulativeboolean- Return running totals instead of per-bucket values. Example: false.
customer_idinteger- Filter by customer ID. Example: 123456.
fromstring- First day of the period. Combined with to, takes precedence over year. Example: 2026-01-01.
periodicitystring- Bucket size: Daily, Weekly, Monthly (default), Quarterly or Annually. Example: Daily.one of
DailyWeeklyMonthlyQuarterlyAnnually product_idinteger- Filter by product ID. Example: 345678.
supplier_idinteger- Filter by supplier ID. Example: 234567.
tostring- Last day of the period, included. Example: 2026-12-31.
typestring- Dimension to break down by. Example: Sales.one of
SalesExpensesCustomerSupplierProductColleagueMarginDiscount yearinteger- Shorthand for a whole calendar year (defaults to the current one). Ignored when a range is given. Example: 2026.
altoviz_units_listList the units of measure.Read-onlyList Units
List the units of measure. Returns each unit's ID and label to use in products.
Inputs
This tool takes no inputs.
altoviz_unpaid_invoices_getGet the aged balance of money customers owe, bucketed by how overdue it is.Read-onlyGet Unpaid Invoices Aging
Get the aged balance of money customers owe, bucketed by how overdue it is. Returns totals per aging bucket.
Inputs
This tool takes no inputs.
altoviz_vats_listList the VAT rates available in the account.Read-onlyList VAT Rates
List the VAT rates available in the account. Returns each rate and region to use in document lines and products.
Inputs
This tool takes no inputs.
altoviz_webhooks_listList the registered webhooks.Read-onlyList Webhooks
List the registered webhooks. Returns each webhook's ID, name, URL and event types.
Inputs
This tool takes no inputs.
altoviz_contact_createCreate a contact person.WriteCreate Contact
Create a contact person. Returns the new contact with its ID.
Inputs
cell_phonestring- Cell Phone. Example: +33 6 12 34 56 78.
company_namestring- Company Name. Example: Acme SAS.
emailstring- Email. Example: anna.martin@acme.fr.
first_namestring- First Name. Example: Anna.
functionstring- Function. Example: CFO.
internal_idstring- ID used in your system. Example: crm-c-55.
last_namestring- Last Name. Example: Martin.
phonestring- Phone. Example: +33 1 23 45 67 89.
servicestring- Service. Example: Finance.
titlestring- Title. Example: Mme.
altoviz_contact_updateUpdate a contact person's details.WriteUpdate Contact
Update a contact person's details. Returns the updated contact. Only the fields you pass change.
- Idempotent
Inputs
contact_idintegerrequired- Altoviz ID of the contact. Example: 123456.
cell_phonestring- Cell Phone. Example: +33 6 12 34 56 78.
company_namestring- Company Name. Example: Acme SAS.
emailstring- Email. Example: anna.martin@acme.fr.
first_namestring- First Name. Example: Anna.
functionstring- Function. Example: CFO.
internal_idstring- ID used in your system. Example: crm-c-55.
last_namestring- Last Name. Example: Martin.
phonestring- Phone. Example: +33 1 23 45 67 89.
servicestring- Service. Example: Finance.
titlestring- Title. Example: Mme.
altoviz_customer_createCreate a customer.WriteCreate Customer
Create a customer. Returns the new customer with its ID and number. Set internal_id to your own ID so you can find it later.
Inputs
activeboolean- false to archive the record. Example: true.
billing_addressobject- Billing address with street, zipcode, city and countryIso. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
cell_phonestring- Cell phone number. Example: +33 6 12 34 56 78.
company_namestring- Company name, for a business. Example: Acme SAS.
emailstring- Email. Example: anna.martin@acme.fr.
first_namestring- First name. Example: Anna.
internal_idstring- Your own ID for this record, to find it later with GetByInternalId. Example: crm-1001.
internal_notesstring- Internal notes. Example: Key account.
last_namestring- Last name. Example: Martin.
metadataobject- Free key-value data for your integration. Example: {"crmId": "1001"}.
numberstring- Number in Altoviz; leave empty to number it automatically. Example: C00012.
phonestring- Phone number. Example: +33 1 23 45 67 89.
shipping_addressobject- Shipping address, same shape as billing_address. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
titlestring- Title. Example: Mme.
typestring- Customer type: Business, Consumer or Government. Example: Business.one of
BusinessConsumerGovernment
altoviz_customer_updateUpdate a customer's name, contact details, addresses or notes.WriteUpdate Customer
Update a customer's name, contact details, addresses or notes. Returns the updated customer. Only the fields you pass change.
- Idempotent
Inputs
customer_idintegerrequired- Altoviz ID of the customer. Example: 123456.
activeboolean- false to archive the record. Example: true.
billing_addressobject- Billing address with street, zipcode, city and countryIso. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
cell_phonestring- Cell phone number. Example: +33 6 12 34 56 78.
company_namestring- Company name, for a business. Example: Acme SAS.
emailstring- Email. Example: anna.martin@acme.fr.
first_namestring- First name. Example: Anna.
internal_idstring- Your own ID for this record, to find it later with GetByInternalId. Example: crm-1001.
internal_notesstring- Internal notes. Example: Key account.
last_namestring- Last name. Example: Martin.
metadataobject- Free key-value data for your integration. Example: {"crmId": "1001"}.
numberstring- Number in Altoviz; leave empty to number it automatically. Example: C00012.
phonestring- Phone number. Example: +33 1 23 45 67 89.
shipping_addressobject- Shipping address, same shape as billing_address. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
titlestring- Title. Example: Mme.
typestring- Customer type: Business, Consumer or Government. Example: Business.one of
BusinessConsumerGovernment
altoviz_product_createCreate a product or service in the catalogue.WriteCreate Product
Create a product or service in the catalogue. Returns the new product with its ID.
Inputs
activeboolean- false to archive the product. Example: true.
default_quantitynumber- Default quantity. Example: 1.
descriptionstring- Description. Example: One day of consulting.
internal_idstring- Your own ID for this product. Example: sku-cons.
internal_notesstring- Internal notes. Example: Standard rate.
metadataobject- Metadata: free-form key/value pairs carried with the product, for an integration to keep its own identifiers and flags against it. Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as `null`. Omitting the property entirely leaves the whole bag untouched, and `""` stores an empty value rather than removing the key. Example: {"sku": "CONS"}.
namestring- Name. Example: Consulting day.
numberstring- Number. Example: P-CONS.
purchase_vatobject- Purchase VAT, same shape as sales_vat. Example: {"rate": 20, "region": "FR"}.
sales_vatobject- Sales VAT with rate and region. Example: {"rate": 20, "region": "FR"}.
tax_excluded_purchase_pricenumber- Purchase price excluding tax: the cost the margin is computed on. Example: 0.
tax_excluded_sales_pricenumber- Sale price excluding tax. On update, the price is left unchanged unless this, `taxIncludedSalesPrice` or one of the deprecated price fields is sent. Example: 600.
tax_included_sales_pricenumber- Sale price including tax. Example: 720.
typestring- Product or service type. Example: Service.one of
ProductServiceText unitobject- Unit of measure as an object with an id from altoviz_units_list. Example: {"id": 1}.
altoviz_product_updateUpdate a product's name, prices, VAT or unit.WriteUpdate Product
Update a product's name, prices, VAT or unit. Returns the updated product. Only the fields you pass change.
- Idempotent
Inputs
product_idintegerrequired- Altoviz ID of the product. Example: 123456.
activeboolean- false to archive the product. Example: true.
default_quantitynumber- Default quantity. Example: 1.
descriptionstring- Description. Example: One day of consulting.
internal_idstring- Your own ID for this product. Example: sku-cons.
internal_notesstring- Internal notes. Example: Standard rate.
metadataobject- Metadata: free-form key/value pairs carried with the product, for an integration to keep its own identifiers and flags against it. Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as `null`. Omitting the property entirely leaves the whole bag untouched, and `""` stores an empty value rather than removing the key. Example: {"sku": "CONS"}.
namestring- Name. Example: Consulting day.
numberstring- Number. Example: P-CONS.
purchase_vatobject- Purchase VAT, same shape as sales_vat. Example: {"rate": 20, "region": "FR"}.
sales_vatobject- Sales VAT with rate and region. Example: {"rate": 20, "region": "FR"}.
tax_excluded_purchase_pricenumber- Purchase price excluding tax: the cost the margin is computed on. Example: 0.
tax_excluded_sales_pricenumber- Sale price excluding tax. On update, the price is left unchanged unless this, `taxIncludedSalesPrice` or one of the deprecated price fields is sent. Example: 600.
tax_included_sales_pricenumber- Sale price including tax. Example: 720.
typestring- Product or service type. Example: Service.one of
ProductServiceText unitobject- Unit of measure as an object with an id from altoviz_units_list. Example: {"id": 1}.
altoviz_receipt_createRecord a payment received from a customer, optionally linked to invoices.WriteCreate Receipt
Record a payment received from a customer, optionally linked to invoices. Returns the new receipt.
Inputs
amountnumber- Amount received. Example: 3600.
customer_idinteger- ID of the customer who paid. Example: 123456.
customer_internal_idstring- Customer number. Example: crm-1001.
customer_numberstring- Customer number. Example: C00012.
datestring- Payment date, YYYY-MM-DD. Example: 2026-06-15.
internal_idstring- Internal ID. Example: pay-1001.
linksarray- Invoices this payment settles, as objects with the invoice id and amount. Example: [{"id": 98765, "amount": 3600}].
metadataobject- Free key-value data for your integration. Example: {"bank": "BNP"}.
notesstring- Notes. Example: Bank transfer.
payment_methodstring- Payment method. Example: Transfer.one of
TransferOrderCheckCashCardBillUsecOnlinePaymentOther referencestring- Payment reference. Example: VIR-2026-0615.
altoviz_sales_credit_createCreate a draft credit note for a customer with its lines.WriteCreate Draft Credit Note
Create a draft credit note for a customer with its lines. Returns the draft credit note with its ID. Use altoviz_sales_credit_finalize to lock it.
Inputs
linesarrayrequired- Lines of the document. Each line has a type (Product, Service, Text, Subtotal.), either a productId (or productInternalId/productNumber) or a description, a quantity, a unit price (taxExcludedPrice or taxIncludedPrice) and a vat with rate and region (FR, EU, .). Example: [{"type": "Service", "description": "Consulting - May", "quantity": 5, "taxExcludedPrice": 600, "vat": {"rate": 20, "region": "FR"}}].
billing_addressobject- Billing address with street, zipcode, city and countryIso. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
customer_idinteger- ID of the customer. Get it from altoviz_customers_list or altoviz_customer_find. Example: 123456.
customer_numberstring- Customer number, as an alternative to customer_id. Example: C00012.
customer_order_referencestring- Customer's purchase order reference. Example: PO-7781.
datestring- Document date, YYYY-MM-DD. Example: 2026-05-31.
footer_notesstring- Text shown below the lines. Example: Payment within 30 days.
global_discountobject- Discount on the whole document: type Percent or Fixed and a value. Example: {"type": "Percent", "value": 10}.
header_notesstring- Text shown above the lines. Example: Thank you for your business.
internal_idstring- Your own ID for this document. Example: crm-inv-1001.
internal_notesstring- Private notes, not shown to the customer. Example: Approved by Anna.
metadataobject- Free key-value data for your integration. Example: {"crmDealId": "D-42"}.
numberstring- Document number; leave empty to number it automatically. Example: AV2026-0003.
shipping_amountnumber- Shipping cost. Example: 0.
subjectstring- Subject line. Example: Consulting May 2026.
use_tax_included_pricesboolean- true if line prices include tax. Example: false.
vat_notestring- VAT mention printed on the document. Example: TVA non applicable, art. 293 B du CGI.
altoviz_sales_credit_finalizeFinalize a draft credit note: number and lock it.WriteFinalize Credit Note
Finalize a draft credit note: number and lock it. Returns the finalized credit note.
Inputs
sales_credit_idintegerrequired- Altoviz ID of the sales credit. Example: 123456.
date_adjustmentstring- How the credit date is recalculated when it prevents finalization, i.e. when it is earlier than the last finalized credit or too far in the future. None (default): keep the date, finalization fails. MinimumDate: use the date of the last finalized credit. Today: use today's date. When finalizationDate is also supplied, it is used first and this only applies if that date cannot be finalized on. Due dates are recalculated from the resulting date. Example: None.one of
NoneMinimumDateToday finalization_datestring- Date the credit is finalized on. Defaults to the credit's own date. Example: 2026-01-01T00:00:00Z.
altoviz_sales_credit_sendEmail a finalized credit note to one or more addresses.WriteSend Credit Note
Email a finalized credit note to one or more addresses. Returns an empty response on success.
Inputs
emailsarrayrequired- Email addresses to send the credit note to. Example: ["anna.martin@acme.fr"].
sales_credit_idintegerrequired- Altoviz ID of the sales credit. Example: 123456.
altoviz_sales_invoice_createCreate a draft sales invoice for a customer with its lines.WriteCreate Draft Sales Invoice
Create a draft sales invoice for a customer with its lines. Returns the draft invoice with its ID and totals. Use altoviz_sales_invoice_finalize to number and lock it, then altoviz_sales_invoice_send to email it.
Inputs
linesarrayrequired- Lines of the document. Each line has a type (Product, Service, Text, Subtotal.), either a productId (or productInternalId/productNumber) or a description, a quantity, a unit price (taxExcludedPrice or taxIncludedPrice) and a vat with rate and region (FR, EU, .). Example: [{"type": "Service", "description": "Consulting - May", "quantity": 5, "taxExcludedPrice": 600, "vat": {"rate": 20, "region": "FR"}}].
billing_addressobject- Billing address with street, zipcode, city and countryIso. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
customer_idinteger- ID of the customer. Get it from altoviz_customers_list or altoviz_customer_find. Example: 123456.
customer_numberstring- Customer number, as an alternative to customer_id. Example: C00012.
customer_order_referencestring- Customer's purchase order reference. Example: PO-7781.
datestring- Document date, YYYY-MM-DD. Example: 2026-05-31.
footer_notesstring- Text shown below the lines. Example: Payment within 30 days.
global_discountobject- Discount on the whole document: type Percent or Fixed and a value. Example: {"type": "Percent", "value": 10}.
header_notesstring- Text shown above the lines. Example: Thank you for your business.
internal_idstring- Your own ID for this document. Example: crm-inv-1001.
internal_notesstring- Private notes, not shown to the customer. Example: Approved by Anna.
metadataobject- Free key-value data for your integration. Example: {"crmDealId": "D-42"}.
numberstring- Document number; leave empty to number it automatically. Example: F2026-0042.
shipping_amountnumber- Shipping cost. Example: 0.
subjectstring- Subject line. Example: Consulting May 2026.
use_tax_included_pricesboolean- true if line prices include tax. Example: false.
vat_notestring- VAT mention printed on the document. Example: TVA non applicable, art. 293 B du CGI.
altoviz_sales_invoice_finalizeFinalize a draft sales invoice: give it its definitive number and lock it.WriteFinalize Sales Invoice
Finalize a draft sales invoice: give it its definitive number and lock it. Returns the finalized invoice. Run altoviz_sales_invoice_einvoicing_check first for e-invoicing customers.
Inputs
sales_invoice_idintegerrequired- Altoviz ID of the sales invoice. Example: 123456.
date_adjustmentstring- How the invoice date is recalculated when it prevents finalization, i.e. when it is earlier than the last finalized invoice or too far in the future. None (default): keep the date, finalization fails. MinimumDate: use the date of the last finalized invoice. Today: use today's date. When finalizationDate is also supplied, it is used first and this only applies if that date cannot be finalized on. Due dates are recalculated from the resulting date. Example: None.one of
NoneMinimumDateToday finalization_datestring- Date the invoice is finalized on. Defaults to the invoice's own date. Example: 2026-01-01T00:00:00Z.
altoviz_sales_invoice_mark_paidRecord a payment on a sales invoice, optionally finalizing it first.WriteMark Sales Invoice Paid
Record a payment on a sales invoice, optionally finalizing it first. Returns the updated invoice.
Inputs
invoice_idintegerrequired- ID of the invoice. Get it from altoviz_sales_invoices_list. Example: 98765.
allow_updateboolean- true to allow updating an existing payment. Example: false.
amountnumber- Amount paid; defaults to the remaining balance. Example: 3600.
datestring- Payment date, YYYY-MM-DD. Example: 2026-06-15.
finalization_datestring- Date to finalize with, YYYY-MM-DD. Example: 2026-06-15.
finalize_invoiceboolean- true to finalize a draft invoice before recording the payment. Example: false.
payment_methodstring- Payment method. Example: Transfer.one of
TransferOrderCheckCashCardBillUsecOnlinePaymentOther payment_referencestring- Payment reference, such as a transfer ID. Example: VIR-2026-0615.
altoviz_sales_invoice_sendEmail a finalized sales invoice to one or more addresses.WriteSend Sales Invoice
Email a finalized sales invoice to one or more addresses. Returns an empty response on success.
Inputs
emailsarrayrequired- Email addresses to send the sales invoice to. Example: ["anna.martin@acme.fr"].
sales_invoice_idintegerrequired- Altoviz ID of the sales invoice. Example: 123456.
altoviz_sales_invoice_updateUpdate a draft sales invoice's customer, date, lines or notes.WriteUpdate Draft Sales Invoice
Update a draft sales invoice's customer, date, lines or notes. Returns the updated invoice. Finalized invoices cannot change; issue a credit note instead.
- Idempotent
Inputs
sales_invoice_idintegerrequired- Altoviz ID of the sales invoice. Example: 123456.
billing_addressobject- Billing address with street, zipcode, city and countryIso. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
customer_idinteger- ID of the customer. Get it from altoviz_customers_list or altoviz_customer_find. Example: 123456.
customer_numberstring- Customer number, as an alternative to customer_id. Example: C00012.
customer_order_referencestring- Customer's purchase order reference. Example: PO-7781.
datestring- Document date, YYYY-MM-DD. Example: 2026-05-31.
footer_notesstring- Text shown below the lines. Example: Payment within 30 days.
global_discountobject- Discount on the whole document: type Percent or Fixed and a value. Example: {"type": "Percent", "value": 10}.
header_notesstring- Text shown above the lines. Example: Thank you for your business.
internal_idstring- Your own ID for this document. Example: crm-inv-1001.
internal_notesstring- Private notes, not shown to the customer. Example: Approved by Anna.
linesarray- Lines of the document. Each line has a type (Product, Service, Text, Subtotal.), either a productId (or productInternalId/productNumber) or a description, a quantity, a unit price (taxExcludedPrice or taxIncludedPrice) and a vat with rate and region (FR, EU, .). Example: [{"type": "Service", "description": "Consulting - May", "quantity": 5, "taxExcludedPrice": 600, "vat": {"rate": 20, "region": "FR"}}].
metadataobject- Free key-value data for your integration. Example: {"crmDealId": "D-42"}.
numberstring- Document number; leave empty to number it automatically. Example: F2026-0042.
shipping_amountnumber- Shipping cost. Example: 0.
subjectstring- Subject line. Example: Consulting May 2026.
use_tax_included_pricesboolean- true if line prices include tax. Example: false.
vat_notestring- VAT mention printed on the document. Example: TVA non applicable, art. 293 B du CGI.
altoviz_sales_quote_createCreate a sales quote for a customer with its lines.WriteCreate Sales Quote
Create a sales quote for a customer with its lines. Returns the quote with its ID, number and totals. Use altoviz_sales_quote_send to email it.
Inputs
linesarrayrequired- Lines of the document. Each line has a type (Product, Service, Text, Subtotal.), either a productId (or productInternalId/productNumber) or a description, a quantity, a unit price (taxExcludedPrice or taxIncludedPrice) and a vat with rate and region (FR, EU, .). Example: [{"type": "Service", "description": "Consulting - May", "quantity": 5, "taxExcludedPrice": 600, "vat": {"rate": 20, "region": "FR"}}].
billing_addressobject- Billing address with street, zipcode, city and countryIso. Example: {"street": "1 rue de Rivoli", "zipcode": "75001", "city": "Paris", "countryIso": "FR"}.
customer_idinteger- ID of the customer. Get it from altoviz_customers_list or altoviz_customer_find. Example: 123456.
customer_numberstring- Customer number, as an alternative to customer_id. Example: C00012.
customer_order_referencestring- Customer's purchase order reference. Example: PO-7781.
datestring- Document date, YYYY-MM-DD. Example: 2026-05-31.
footer_notesstring- Text shown below the lines. Example: Payment within 30 days.
global_discountobject- Discount on the whole document: type Percent or Fixed and a value. Example: {"type": "Percent", "value": 10}.
header_notesstring- Text shown above the lines. Example: Thank you for your business.
internal_idstring- Your own ID for this document. Example: crm-inv-1001.
internal_notesstring- Private notes, not shown to the customer. Example: Approved by Anna.
metadataobject- Free key-value data for your integration. Example: {"crmDealId": "D-42"}.
numberstring- Document number; leave empty to number it automatically. Example: D2026-0012.
shipping_amountnumber- Shipping cost. Example: 0.
subjectstring- Subject line. Example: Consulting May 2026.
use_tax_included_pricesboolean- true if line prices include tax. Example: false.
validity_datestring- Date the quote expires, YYYY-MM-DD. Example: 2026-06-30.
vat_notestring- VAT mention printed on the document. Example: TVA non applicable, art. 293 B du CGI.
altoviz_sales_quote_sendEmail a sales quote to one or more addresses.WriteSend Sales Quote
Email a sales quote to one or more addresses. Returns an empty response on success.
Inputs
emailsarrayrequired- Email addresses to send the sales quote to. Example: ["anna.martin@acme.fr"].
sales_quote_idintegerrequired- Altoviz ID of the sales quote. Example: 123456.
altoviz_supplier_createCreate a supplier.WriteCreate Supplier
Create a supplier. Returns the new supplier with its ID.
Inputs
activeboolean- false to archive the record. Example: true.
cell_phonestring- Cell phone number. Example: +33 6 12 34 56 78.
emailstring- Email. Example: billing@supplier.fr.
first_namestring- First name. Example: Anna.
internal_idstring- Your own ID for this record, to find it later with GetByInternalId. Example: erp-sup-7.
internal_notesstring- Internal notes. Example: Key account.
last_namestring- Last name. Example: Martin.
numberstring- Number in Altoviz; leave empty to number it automatically. Example: S00007.
phonestring- Phone number. Example: +33 1 23 45 67 89.
titlestring- Title. Example: Mme.
altoviz_supplier_updateUpdate a supplier's details or addresses.WriteUpdate Supplier
Update a supplier's details or addresses. Returns the updated supplier. Only the fields you pass change.
- Idempotent
Inputs
supplier_idintegerrequired- Altoviz ID of the customer. Example: 123456.
activeboolean- false to archive the record. Example: true.
cell_phonestring- Cell phone number. Example: +33 6 12 34 56 78.
emailstring- Email. Example: billing@supplier.fr.
first_namestring- First name. Example: Anna.
internal_idstring- Your own ID for this record, to find it later with GetByInternalId. Example: erp-sup-7.
internal_notesstring- Internal notes. Example: Key account.
last_namestring- Last name. Example: Martin.
numberstring- Number in Altoviz; leave empty to number it automatically. Example: S00007.
phonestring- Phone number. Example: +33 1 23 45 67 89.
titlestring- Title. Example: Mme.
altoviz_webhook_createRegister a webhook URL for Altoviz events.WriteCreate Webhook
Register a webhook URL for Altoviz events. Returns the new webhook.
Inputs
namestringrequired- Name of the webhook. Example: CRM sync.
typesarrayrequired- Event types to send. Example: ["InvoiceCreated", "CustomerCreated"].
urlstringrequired- HTTPS URL Altoviz posts events to. Example: https://example.com/hooks/altoviz.
secret_keystring- Secret used to sign the requests. Example: whsec_123.
altoviz_contact_deleteDelete a contact person.DestructiveDelete Contact
Delete a contact person. Returns an empty response on success.
- Idempotent
Inputs
contact_idintegerrequired- Altoviz ID of the contact. Example: 123456.
altoviz_customer_deleteDelete a customer.DestructiveDelete Customer
Delete a customer. Returns an empty response on success. Set active to false with altoviz_customer_update to archive instead.
- Idempotent
Inputs
customer_idintegerrequired- Altoviz ID of the customer. Example: 123456.
altoviz_product_deleteDelete a product.DestructiveDelete Product
Delete a product. Returns an empty response on success.
- Idempotent
Inputs
product_idintegerrequired- Altoviz ID of the product. Example: 123456.
altoviz_sales_invoice_deleteDelete a draft sales invoice.DestructiveDelete Draft Sales Invoice
Delete a draft sales invoice. Returns an empty response on success. Finalized invoices cannot be deleted.
- Idempotent
Inputs
sales_invoice_idintegerrequired- Altoviz ID of the sales invoice. Example: 123456.
detach_paymentsboolean- Detach the payments allocated to the invoice, and keep them unallocated, instead of refusing the deletion. Example: true.
altoviz_sales_quote_deleteDelete a sales quote.DestructiveDelete Sales Quote
Delete a sales quote. Returns an empty response on success.
- Idempotent
Inputs
sales_quote_idintegerrequired- Altoviz ID of the sales quote. Example: 123456.
altoviz_supplier_deleteDelete a supplier.DestructiveDelete Supplier
Delete a supplier. Returns an empty response on success.
- Idempotent
Inputs
supplier_idintegerrequired- Altoviz ID of the supplier. Example: 123456.
altoviz_webhook_deleteUnregister a webhook by ID or URL.DestructiveDelete Webhook
Unregister a webhook by ID or URL. Returns an empty response on success.
- Idempotent
Inputs
idinteger- ID of the webhook. Get it from altoviz_webhooks_list. Example: 12.
urlstring- URL of the webhook, instead of the ID. Example: https://example.com/hooks/altoviz.
No tools match.