Skip to main content
Altoviz logo
  • Category: accounting
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 67
  • Triggers: 0
  • Slug: ALTOVIZ
  • Version: 20261101_00

Tools

Slug: ALTOVIZ_CREATE_CONTACTCreates a new contact in the Altoviz system. Use when you need to add a new contact with details like name, email, phone, and company information.

Input Parameters

string
Email address of the contact
string
Phone number of the contact
string
Job title of the contact
string
Service or department information
string
Job function or department of the contact
string
Last name of the contact
string
Cell phone number of the contact
string
First name of the contact
string
Internal ID used for reference in your system
string
Company name of the contact
string
Display name for the contact
string
Inverted display name (last name, first name)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_CUSTOMERCreates a new customer in Altoviz. Use type=‘Company’ for business customers (requires companyName) or type=‘Individual’ for personal customers (typically uses firstName/lastName).

Input Parameters

string ("Company" | "Individual" | "Consumer" | "Business")
required
Type of customer: ‘Company’ for businesses or ‘Individual’ for persons. This determines which fields are required.
string
Email address of the customer
string
Landline/office phone number
string
Customer title/salutation (e.g., Mr., Mrs., Dr.)
boolean
Whether the customer account is active (default: true)
object
Customer family/classification
string
Custom customer number/reference code
string
Last name - typically used when type is ‘Individual’
string
Mobile/cell phone number
string
First name - typically used when type is ‘Individual’
string
Your own unique identifier for this customer, useful for integration with external systems
string
Company name - required when type is ‘Company’
string
Private internal notes about the customer
object
Address details
object
Billing options for the customer
object
Address details
object
Company-specific information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_CUSTOMER_FAMILYCreates a new customer family in Altoviz for categorizing and organizing customers into groups. Use when you need to create customer segments or categories for better organization.

Input Parameters

string
The name/label of the customer family for categorization
string
A unique reference number or code for the customer family
string
Your internal reference ID for syncing with external systems

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_PRODUCTCreates a new product in the Altoviz system. This tool allows for the independent creation of a product with all necessary details.

Input Parameters

object
VAT rate object. Use ALTOVIZ_GET_VATS to retrieve available rates. Must include: id, rate, region, label. Example: {‘id’: 51616, ‘rate’: 20.0, ‘region’: ‘FR’, ‘label’: ‘20.0% - FR’}
string
required
Name of the product
object
Unit of measurement object. Use ALTOVIZ_GET_UNITS to retrieve available units. Must include: id, name, code, type, conversion, decimals. Example: {‘id’: 23112, ‘name’: ‘Kilogrammes’, ‘code’: ‘KG’, ‘type’: ‘Weight’, ‘conversion’: 1.0, ‘decimals’: 3.0}
boolean
Whether the product is active and available for use
object
Product family/classification object for categorization. Must include: id and label fields
string
required
Unique product number or SKU identifier
number
required
Selling price of the product (must be greater than 0)
string
required
Detailed description of the product
string
Your internal reference ID for syncing with external systems
string ("Product" | "Service")
required
Type of item: ‘Product’ for physical goods, ‘Service’ for services
string
Private notes about the product (not visible to customers)
number
required
Cost/purchase price of the product (must be greater than 0)
number
Default quantity when adding product to invoices/quotes
boolean
True if unit_price includes VAT, False if price is before tax

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_PRODUCT_FAMILYTool to create a new product family in Altoviz. Use when you need to organize products into categories or families for better inventory management.

Input Parameters

string
required
Label or name of the product family for categorization
string
Unique reference number or code for the product family

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_RECEIPTCreates a new receipt in the Altoviz system to record customer payments. Use when you need to document received payments and optionally link them to invoices or other documents.

Input Parameters

string
required
Receipt date in ISO 8601 format (YYYY-MM-DD)
List of links to mark documents (invoices/quotes) as paid. Each link must include document ID, amount, and type.
string
Additional notes or comments about the receipt
number
required
Receipt amount (must be greater than 0)
string ("Success" | "Pending" | "Failed")
Receipt status. If not specified, defaults to Success.
object
Additional metadata as key-value pairs for custom data storage
string
External reference number (e.g., check number, transaction ID)
integer
Unique customer ID in Altoviz. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs by email.
string
Your internal reference ID for this receipt
string
Customer name
string ("Transfer" | "Order" | "Check" | "Cash" | "Card" | "Bill" | "Usec" | "Other")
required
Payment method used for the receipt
string
Customer number/reference code
string
Your internal customer identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_SALE_CREDITCreates a new draft credit note (avoir) in Altoviz. Credit notes are used to cancel or refund invoices. The credit note is created in draft status and can be modified before being finalized.

Input Parameters

string
Date of the credit note in YYYY-MM-DD format. If not provided, current date will be used.
array
Line items for the credit note. Each line must include: description (string), quantity (number), type (‘Product’ or ‘Service’), and either taxExcludedPrice or taxIncludedPrice depending on useTaxIncludedPrices setting.
string ("FR" | "EU" | "IE" | "DOM" | "Corse" | "Monaco")
required
Tax region for this credit note. Must be one of: FR (France), EU (European Union), IE (Ireland), DOM (French overseas territories), Corse (Corsica), Monaco
string
Subject/title for the credit note
string ("Auto" | "Debit" | "Collection")
VAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment)
string
VAT note to print on the credit note
object
Additional metadata as key-value pairs
integer
Customer ID to associate with this credit note. Either customerId or customerNumber must be provided. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs.
string
Your own internal reference ID for this credit note
Notes to print in the footer section of the credit note
string
Notes to print in the header section of the credit note
boolean
Indicates whether the document is liable to VAT
string
Customer name to display on the credit note
string
Internal notes (not printed on the credit note)
object
Billing address for the customer
object
Billing contact information
string
Customer reference number. Either customerId or customerNumber must be provided.
object
Global discount applied to the entire credit note
number
Shipping amount to include in the credit note
object
Shipping address for the customer
object
Shipping contact information
string
Vendor reference to be printed
boolean
Set to true if VAT reverse charge applies
string
Customer’s VAT registration number
integer
ID of the invoice this credit note cancels/refunds
boolean
required
Set to true if prices include tax/VAT, false if prices are pre-tax amounts
string
Customer’s order reference number
string
Number of the invoice this credit note cancels/refunds

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_CREATE_SALE_INVOICECreates a new draft sale invoice in Altoviz. The invoice is created in draft status and can be modified before being finalized. Use when you need to generate an invoice for a customer with line items.

Input Parameters

string
Date of the invoice in YYYY-MM-DD format. If not provided, current date will be used.
array
required
Line items for the invoice. At least one line item is required.
string ("FR" | "EU" | "IE" | "DOM" | "Corse" | "Monaco")
Tax region for this invoice. Must be one of: FR (France), EU (European Union), IE (Ireland), DOM (French overseas territories), Corse (Corsica), Monaco. If not provided, will use customer’s default region.
string
Subject/title for the invoice
string ("Auto" | "Debit" | "Collection")
VAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment)
string
VAT note to print on the invoice
object
Additional metadata as key-value pairs
integer
required
Customer ID to associate with this invoice. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs.
string
Your own internal reference ID for this invoice
Notes to print in the footer section of the invoice
string
Notes to print in the header section of the invoice
boolean
Indicates whether the invoice is liable to VAT
object
VAT rate for shipping. Use ALTOVIZ_GET_VATS to retrieve available VAT rates.
string
Customer name to display on the invoice (overrides customer’s name)
string
Internal notes (not printed on the invoice)
object
Billing address for the customer (overrides customer’s default)
object
Billing contact information
string
Customer reference number
object
Global discount applied to the entire invoice
number
Shipping amount to include in the invoice
object
Shipping address for the customer (overrides customer’s default)
object
Shipping contact information
string
Vendor reference to be printed
boolean
Set to true if VAT reverse charge applies
string
Customer’s VAT registration number
boolean
Set to true if prices include tax/VAT, false if prices are pre-tax amounts. If not provided, will use customer’s default setting.
string
Customer’s order reference number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_COLLEAGUETool to delete a colleague from Altoviz. Use when you need to permanently remove a colleague from the system.

Input Parameters

integer
required
Colleague id to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_CUSTOMERTool to delete a customer from Altoviz. Use when you need to permanently remove a customer record from the system. Use ALTOVIZ_FIND_CUSTOMER first to look up customer IDs by email address if needed.

Input Parameters

string
required
The unique identifier of the customer to delete. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs by email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_CUSTOMER_FAMILYTool to delete a customer family from Altoviz. Use when you need to permanently remove a customer family from the system.

Input Parameters

integer
required
Customer family id to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_PRODUCTThis tool allows you to delete an existing product from Altoviz. The action permanently removes the product from the system.

Input Parameters

string
required
The unique identifier of the product to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_PRODUCT_FAMILYTool to delete a product family from Altoviz. Use when you need to permanently remove a product family from the system.

Input Parameters

integer
required
Product family id to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_RECEIPTTool to delete a receipt from Altoviz. Use when you need to permanently remove a receipt from the system.

Input Parameters

integer
required
The unique identifier of the receipt to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_SALE_CREDITTool to delete a draft credit from Altoviz. Use when you need to permanently remove a draft credit. Only draft credits can be deleted; finalized credits cannot be removed.

Input Parameters

integer
required
Draft credit ID to delete. Only draft credits can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_SALE_INVOICETool to delete a draft sale invoice from Altoviz. Use when you need to permanently remove a draft invoice from the system. Only draft invoices can be deleted; finalized invoices cannot be deleted.

Input Parameters

integer
required
The unique identifier of the draft invoice to delete. Only draft invoices can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_SALE_QUOTETool to delete a sale quote from Altoviz. Use when you need to permanently remove a quote from the system.

Input Parameters

integer
required
The unique identifier of the sale quote to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DELETE_SUPPLIERTool to delete a supplier from Altoviz. Use when you need to permanently remove a supplier record from the system.

Input Parameters

integer
required
The unique identifier of the supplier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DOWNLOAD_PURCHASE_INVOICETool to download a purchase invoice as a PDF file from Altoviz. Use when you need to retrieve the PDF document of a specific purchase invoice.

Input Parameters

integer
required
The unique identifier of the purchase invoice to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DOWNLOAD_SALE_CREDITTool to download a sale credit as a PDF file from Altoviz. Use when you need to retrieve the PDF version of a specific sale credit document.

Input Parameters

integer
required
The unique identifier of the sale credit to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_DOWNLOAD_SALE_INVOICETool to download a sale invoice as a PDF file from Altoviz. Use when you need to retrieve the PDF document of a specific sale invoice.

Input Parameters

integer
required
The unique identifier of the sale invoice to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_CONTACTSearches Altoviz contacts by email address and returns the first contact in the response, if any.

Input Parameters

string
required
The email address to search for in contacts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_CUSTOMERSearches Altoviz customers by email address and returns the first customer in a list response, if any. A non-list response is treated as no customer.

Input Parameters

string
required
The email address of the customer to find

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_PRODUCTSearch for a product in Altoviz by its product number/SKU. Returns the first matching product with complete details including name, description, pricing, VAT, unit of measurement, and more. Returns null if no product matches. Use cases: - Look up a specific product by its SKU before creating an invoice - Verify a product exists before referencing it in orders - Retrieve product pricing and tax information

Input Parameters

string
required
The product number/SKU to search for. Supports partial matching - the search will return the first product whose number contains this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_PRODUCT_BY_NUMBER_OR_IDTool to find a product in Altoviz by exact product number or internal ID. Use when you need to look up a product by either its product number/SKU or your internal system ID. At least one of the parameters must be provided.

Input Parameters

string
Product number/SKU for exact matching. At least one of ‘number’ or ‘internal_id’ must be provided.
string
Internal ID used in your system. At least one of ‘number’ or ‘internal_id’ must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_RECEIPTTool to find receipts in Altoviz by customer internal ID. Returns a list of receipts associated with the specified internal ID. If no internal ID is provided, may return all receipts. Use when you need to search for receipts by customer identifier.

Input Parameters

integer
Number of receipts to return per page (1-100). Controls pagination of results.
integer
Zero-based page index for pagination. Use with PageSize to navigate through results.
string
Customer internal ID to filter receipts. If not provided, returns all receipts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_SALE_CREDITTool to find sale credits in Altoviz. Use when you need to search for or retrieve credit notes. Can filter by internal ID or return all credits if no filter is provided.

Input Parameters

integer
Number of credits to return per page (1-100). Controls pagination of results.
integer
Zero-based page index for pagination. Use with PageSize to navigate through results.
string
Credit internal ID to filter by. If not provided, all credits will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_SALE_INVOICEFind sale invoices in Altoviz, optionally filtering by internal ID. Results support pagination; without an internal ID filter, the request searches invoices without that filter.

Input Parameters

integer
Number of invoices to return per page (1-100). Controls pagination of results.
integer
Zero-based page index for pagination. Use with PageSize to navigate through results.
string
Invoice internal ID to filter by. If not provided, all invoices will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_FIND_SALE_QUOTEFind sale quotes in Altoviz, optionally filtering by internal ID. Results support pagination; without an internal ID filter, the request searches quotes without that filter.

Input Parameters

integer
Number of quotes to return per page (1-100). Controls pagination of results.
integer
Zero-based page index for pagination. Use with PageSize to navigate through results.
string
Quote internal ID to filter by. If not provided, all quotes will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CLASSIFICATIONSThis tool retrieves a list of classifications from the Altoviz platform. Classifications are essential for producing accounting registers from user-created invoices. It can fetch all classifications or filter them by type.

Input Parameters

string ("Sale" | "Expense" | "Other")
Filter classifications by type. Allowed values are ‘Sale’, ‘Expense’, or ‘Other’.
string
Field name to sort the results by. Specify the classification field to use for ordering (e.g., ‘label’, ‘accountNumber’, ‘type’).
integer
The number of classifications to return per page. Controls how many results are returned in a single request.
integer
The page index for pagination (1-based, starting from 1). Use this to navigate through multiple pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_COLLEAGUETool to retrieve a colleague’s details from Altoviz by their ID. Use this when you need to fetch information about a specific colleague including their contact information, partner status, and metadata.

Input Parameters

integer
required
Colleague id to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CONTACTTool to retrieve a contact by its unique ID from Altoviz. Use when you need to fetch detailed information about a specific contact.

Input Parameters

integer
required
The unique identifier of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CURRENT_USERTool to retrieve the current authenticated user’s information from Altoviz. Use when you need to get details about the currently authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CUSTOMERTool to retrieve a customer by their ID from Altoviz. Use when you need detailed information about a specific customer.

Input Parameters

integer
required
Customer ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CUSTOMER_BY_INTERNAL_IDTool to retrieve a single customer from Altoviz by their internal ID. Use when you need to fetch detailed information about a specific customer using their internal identifier.

Input Parameters

string
required
The internal ID of the customer to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CUSTOMER_CONTACTSTool to retrieve all contacts associated with a specific customer in Altoviz. Use when you need to get contact information for a customer using their customer ID.

Input Parameters

integer
required
Customer ID to retrieve contacts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_CUSTOMER_FAMILYTool to retrieve a customer family by ID from Altoviz. Use when you need to fetch details of a specific customer family.

Input Parameters

integer
required
Customer family id to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_PRODUCTRetrieve an Altoviz product by its unique ID, including available pricing, VAT, and unit details.

Input Parameters

integer
required
Product ID to retrieve. This is the unique identifier of the product in Altoviz.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_PRODUCT_FAMILYTool to retrieve a specific product family by its ID from Altoviz. Use when you need to fetch details about a product category or family grouping.

Input Parameters

integer
required
Product family ID to retrieve. Must be a valid product family identifier from your Altoviz account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_RECEIPTTool to retrieve a receipt by its ID from Altoviz. Use when you need to fetch details of a specific receipt including amount, payment method, status, and customer information.

Input Parameters

integer
required
Receipt id to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_SALE_CREDITTool to retrieve a sale credit by its ID from Altoviz. Use when you need to get detailed information about a specific credit.

Input Parameters

integer
required
Credit ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_SALE_INVOICETool to retrieve a sale invoice by its ID from Altoviz. Use when you need to get detailed information about a specific invoice.

Input Parameters

integer
required
Invoice ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_SETTINGSTool to retrieve application settings from Altoviz. Use when you need to access configuration for accounting, company information, emailing, sales, social media, or VAT settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_SUPPLIERTool to retrieve a supplier by their ID from Altoviz. Use when you need detailed information about a specific supplier.

Input Parameters

integer
required
Supplier ID to retrieve. This is the unique identifier of the supplier in Altoviz.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_SUPPLIER_CONTACTSTool to retrieve all contacts associated with a specific supplier in Altoviz. Use when you need to get contact information for a supplier using their supplier ID.

Input Parameters

integer
required
Supplier ID to retrieve contacts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_UNITSRetrieve a list of available units in Altoviz, with pagination and sorting. Units are used for product measurements and quantity specifications in transactions.

Input Parameters

string
Field name to sort the results by. Specify the unit field to use for ordering (e.g., ‘name’, ‘code’, ‘type’).
integer
The number of units to return per page. Controls how many results are returned in a single request.
integer
The page index for pagination (1-based, starting from 1). Use this to navigate through multiple pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_GET_VATSRetrieve available VAT rates from Altoviz, including their regions and labels, for use in invoices and quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_COLLEAGUESRetrieves a list of colleagues from Altoviz. Supports pagination, sorting, and full-text search. Use this to discover available colleagues, search for specific team members, or list all colleagues in the system.

Input Parameters

string
Full text search query to filter colleagues. Searches across colleague name, email, phone, and other text fields. Use this to find colleagues matching specific keywords.
string
Field name to sort the results by. Common values include ‘name’, ‘lastName’, ‘firstName’, ‘number’. Append ’ desc’ for descending order (e.g., ‘name desc’).
integer
The number of colleagues to return per page. Use this with page_index to control pagination. Typical values are 10, 20, 50, or 100.
integer
The page index for pagination. One-based index (1 = first page, 2 = second page, etc.). Use this with page_size to paginate through large result sets. Must be greater than 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_CONTACTSTool to retrieve a list of contacts from Altoviz with optional filtering and pagination. Use when you need to browse or search through available contacts.

Input Parameters

string
Full text search query to filter contacts. Searches across contact fields like name, email, company, etc.
string
Field name to sort contacts by. Examples: ‘displayName’, ‘email’, ‘lastName’.
integer
The number of contacts to return per page. Use this to control the size of the result set.
integer
The page index for pagination (0-based). Use this to navigate through multiple pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_CUSTOMER_FAMILIESTool to list customer families from Altoviz. Use when you need to retrieve or search through customer family groups. Supports pagination and full-text search to filter results.

Input Parameters

string
Full text search query to filter customer families. Use this to search across all customer family fields.
string
Field name to order the results by. Use this to sort the customer families list.
integer
The number of customer families to return per page. Use this to control the size of the result set.
integer
The page index for pagination. Use this to navigate through multiple pages of results. Must be greater than 0 (starts at 1 for the first page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_CUSTOMERSTool to retrieve a paginated list of customers from Altoviz. Use when you need to browse all customers, search for customers by name/email/company, or fetch multiple customers at once. Supports pagination, sorting, and full-text search across customer fields.

Input Parameters

string
Full text search query to filter customers. Searches across customer fields like name, email, company name, etc.
string
Field name to sort the results by. Specify the customer field to use for ordering the list (e.g., ‘name’, ‘email’, ‘number’).
integer
The number of customers to return per page. Controls how many results are returned in a single request.
integer
The page index for pagination (1-based, starting from 1). Use this to navigate through multiple pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_PRODUCT_FAMILIESTool to retrieve a list of product families from Altoviz. Use when you need to browse available product families, search for specific families, or get family information for product categorization.

Input Parameters

string
Full-text search query to filter product families. Searches across all text fields in product families.
string
Field name to sort the results by. Specify the field name from the product family object (e.g., ‘label’, ‘number’).
integer
Number of product families to return per page. Use for pagination control.
integer
One-based page index for pagination. Use this to navigate through multiple pages of results. Must be greater than 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_RECEIPTSTool to retrieve a list of receipts from Altoviz. Use this when you need to view, search, or filter receipts by pagination, ordering, or full-text search.

Input Parameters

string
Full text search query to filter receipts. Use this to search across receipt fields like reference, customer name, or notes.
string
Field name to sort the results by. Specify the field to order the receipt list (e.g., ‘date’, ‘amount’).
integer
The number of receipts to return per page. Controls how many items are returned in a single request.
integer
The zero-based page index for pagination. Use this to navigate through multiple pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_SALE_CREDITSTool to retrieve a list of sale credits from Altoviz. Use when you need to view credit notes issued to customers, filter by date range, or find credits for a specific customer. Supports pagination and sorting for efficient data retrieval.

Input Parameters

string
Filter credits up to this date (inclusive). Format: YYYY-MM-DD.
string
Filter credits from this date onwards (inclusive). Format: YYYY-MM-DD.
string
The field to order results by. Common values include ‘date’, ‘number’, ‘customerName’.
integer
The number of items to return per page. Recommended range is 1-100.
integer
The page index for pagination (zero-based). Use this to navigate through multiple pages of results.
integer
Filter credits by specific customer ID. Only credits for this customer will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_SALE_INVOICESTool to retrieve a list of sale invoices from Altoviz. Use when you need to view invoices issued to customers, filter by date range, status, or find invoices for a specific customer. Supports pagination, sorting, and status filtering for efficient data retrieval.

Input Parameters

string
Filter invoices up to this date (inclusive). Format: YYYY-MM-DD.
string
Filter invoices from this date onwards (inclusive). Format: YYYY-MM-DD.
string ("Draft" | "Incoming" | "Expired" | "Paid" | "ToSend")
Filter invoices by status. Choose from Draft, Incoming, Expired, Paid, or ToSend.
string
The field to order results by. Common values include ‘date’, ‘number’, ‘customerName’.
integer
The number of items to return per page. Recommended range is 1-100.
integer
The page index for pagination (one-based). Must be greater than 0. Use this to navigate through multiple pages of results.
integer
Filter invoices by specific customer ID. Only invoices for this customer will be returned.
boolean
Indicates whether cancelled invoices should be included in the results. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_SALE_QUOTESTool to retrieve a list of sale quotes from Altoviz. Use when you need to view quotes issued to customers, filter by date range, or find quotes for a specific customer. Supports pagination and sorting for efficient data retrieval.

Input Parameters

string
Filter quotes up to this date (inclusive). Format: YYYY-MM-DD.
string
Filter quotes from this date onwards (inclusive). Format: YYYY-MM-DD.
string
The field to order results by. Common values include ‘date’, ‘number’, ‘customerName’.
integer
The number of items to return per page. Recommended range is 1-100.
integer
The page index for pagination (zero-based). Use this to navigate through multiple pages of results.
integer
Filter quotes by specific customer ID. Only quotes for this customer will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_SUPPLIERSTool to retrieve a paginated list of suppliers from Altoviz. Use when you need to browse all suppliers, search for suppliers by name/email/company, or fetch multiple suppliers at once. Supports pagination, sorting, and full-text search across supplier fields.

Input Parameters

string
Full text search query to filter suppliers. Searches across supplier fields like name, email, company information, etc.
string
Field name to sort the results by. Specify the supplier field to use for ordering the list (e.g., ‘name’, ‘number’, ‘email’).
integer
The number of suppliers to return per page. Controls how many results are returned in a single request. Must be between 1 and 100.
integer
The page index for pagination (1-based). Use this to navigate through multiple pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_LIST_WEBHOOKSTool to retrieve all configured webhooks from Altoviz. Use when you need to view all webhook configurations, including their URLs, event types, and authentication details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_REGISTER_WEBHOOKTool to register a new webhook in Altoviz. Use when you need to receive real-time notifications for events like customer creation, invoice updates, or product changes.

Input Parameters

string
required
Webhook URL where events will be sent (must be a valid HTTPS endpoint)
string
required
Name of the webhook for identification purposes
array
required
List of event types that will trigger this webhook. Select one or more events to monitor.
string
Optional secret key for webhook authentication and signature verification

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_TEST_API_KEYTool to test API key validity and retrieve basic account information. Use this action to verify that the API key is working correctly and to get basic information about the authenticated account.

Input Parameters

string
Optional API version parameter to use for the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UNREGISTER_WEBHOOKTool to unregister a webhook from Altoviz. Use when you need to remove a webhook configuration. Either webhook ID or URL must be provided to identify which webhook to unregister.

Input Parameters

integer
Webhook ID to unregister. Either id or url must be provided.
string
Webhook URL to unregister. Either id or url must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UPDATE_COLLEAGUEUpdates an existing colleague’s information in Altoviz. Only fields that are provided will be updated; omitted fields retain their current values. Use this action to modify colleague details such as contact information, partner status, and associated metadata.

Input Parameters

integer
required
The unique identifier of the colleague to update
string
Full name of the colleague
string
Email address of the colleague
string
Phone number of the colleague
string
Title or position of the colleague
string
Colleague number/reference code
string
User identifier associated with the colleague
string
Last name of the colleague
object
Metadata associated with the colleague as key-value pairs
string
Cell phone number of the colleague
string
First name of the colleague
boolean
Indicates if the colleague is a partner
string
Internal identifier for the colleague, useful for integration with external systems
string
Homecare service number associated with the colleague
number
Initial balance for the partner (if the colleague is a partner)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UPDATE_CUSTOMERUpdates an existing customer’s information in Altoviz. Only fields that are provided will be updated; omitted fields retain their current values. Important: For Individual customers, you must provide either last_name or company_name. Setting company_name will change the customer type to Company. Use ALTOVIZ_FIND_CUSTOMER first to look up customer IDs by email address.

Input Parameters

string
Customer’s email address
string
Customer’s landline/office phone number
string
Customer’s title/salutation
string
Customer’s last name. Required for Individual-type customers when company_name is not set.
string
Customer’s mobile/cell phone number
string
Customer’s first name (for Individual-type customers)
string
required
The unique Altoviz customer ID. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs by email.
string
Your own unique identifier for this customer, useful for integration with external systems
string
Company name. Required for Company-type customers. Setting this changes customer type to Company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UPDATE_RECEIPTUpdates an existing receipt in Altoviz, including details such as amount, date, payment method, status, notes, and document links. Only supplied top-level fields are sent; supplied links can include null values for omitted link fields.

Input Parameters

integer
required
Receipt ID to update
string
Receipt date in ISO 8601 format (YYYY-MM-DD)
Links to mark documents (invoices, quotes, etc.) as paid by this receipt
string
Notes or comments about the receipt
number
Receipt amount. Must be provided when updating receipt details.
string ("Success" | "Pending" | "Failed")
Receipt status.
object
Custom metadata as key-value pairs for integration purposes
string
Payment reference or transaction ID
integer
Customer ID associated with the receipt
string
Your internal reference ID for this receipt
string
Customer name (read-only, auto-populated from customer)
string ("Transfer" | "Order" | "Check" | "Cash" | "Card" | "Bill" | "Usec" | "Other")
Payment method for a receipt.
string
Customer number/reference code
string
Your internal customer identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UPDATE_SALE_CREDITTool to update a draft credit note in Altoviz. Use when you need to modify an existing draft credit. Only draft credits can be updated; finalized credits cannot be modified.

Input Parameters

integer
required
Credit ID to update. Use ALTOVIZ_FIND_SALE_CREDIT to look up credit IDs.
string
Date of the credit note in YYYY-MM-DD format
array
Line items for the credit note. Each line should include fields like productId, quantity, price, description, etc.
string ("FR" | "EU" | "IE" | "DOM" | "Corse" | "Monaco")
Tax region for this credit note. Must be one of: FR (France), EU (European Union), IE (Ireland), DOM (French overseas territories), Corse (Corsica), Monaco
boolean
Set to true to keep as draft, false to finalize. Only draft credits can be modified.
string
Subject/title for the credit note
string ("Auto" | "Debit" | "Collection")
VAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment)
string
VAT note to print on the credit note
object
Additional metadata as key-value pairs
integer
Customer ID to associate with this credit note
string
Your own internal reference ID for this credit note
Notes to print in the footer section of the credit note
string
Notes to print in the header section of the credit note
boolean
Indicates whether the document is liable to VAT
object
Shipping VAT details
string
Customer name to display on the credit note
string
Internal notes (not printed on the credit note)
object
Billing address for the customer
object
Billing contact information
string
Customer reference number
object
Global discount applied to the entire credit note
number
Shipping amount to include in the credit note
object
Shipping address for the customer
object
Shipping contact information
string
Vendor reference to be printed
boolean
Set to true if VAT reverse charge applies
string
Customer’s VAT registration number
integer
ID of the invoice this credit note cancels/refunds
boolean
Set to true if prices include tax/VAT, false if prices are pre-tax amounts
string
Customer’s order reference number
string
Number of the invoice this credit note cancels/refunds

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UPDATE_SUPPLIERUpdate an existing supplier’s information in Altoviz, including contact information, address, default payment method, or internal notes. The request includes only supplied non-null fields.

Input Parameters

integer
required
The unique Altoviz supplier ID to update
string
Company name of the supplier
string
Supplier’s email address
string
Supplier’s phone number
string
Title/salutation for the supplier contact
string
Supplier reference number
object
Supplier’s address information
string
Last name of the supplier contact person
string
Supplier’s mobile/cell phone number
string
First name of the supplier contact person
string
Your own unique identifier for this supplier, useful for integration with external systems
string
Private notes about the supplier (not visible to supplier)
object
Company registration information (SIRET, VAT number)
string ("Transfer" | "Order" | "Check" | "Cash" | "Card" | "Bill" | "Usec" | "Other")
Default payment method for this supplier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTOVIZ_UPLOAD_PURCHASE_INVOICETool to upload and create a new purchase invoice from a file (PDF or image format). Use when you need to create a purchase invoice by uploading a document.

Input Parameters

object
required
The purchase invoice file to upload (PDF or image format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not