# Altoviz

Altoviz is a cloud-based billing and invoicing platform for businesses, offering online payments, expense tracking, document management, and customizable invoices.

- **Category:** accounting
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 67
- **Triggers:** 0
- **Slug:** `ALTOVIZ`
- **Version:** 20260307_00

## Tools

### Create Contact

**Slug:** `ALTOVIZ_CREATE_CONTACT`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address of the contact |
| `phone` | string | No | Phone number of the contact |
| `title` | string | No | Job title of the contact |
| `service` | string | No | Service or department information |
| `function` | string | No | Job function or department of the contact |
| `last_name` | string | No | Last name of the contact |
| `cell_phone` | string | No | Cell phone number of the contact |
| `first_name` | string | No | First name of the contact |
| `internal_id` | string | No | Internal ID used for reference in your system |
| `company_name` | string | No | Company name of the contact |
| `display_name` | string | No | Display name for the contact |
| `inverted_display_name` | string | No | Inverted display name (last name, first name) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `ALTOVIZ_CREATE_CUSTOMER`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("Company" | "Individual") | Yes | Type of customer: 'Company' for businesses or 'Individual' for persons. This determines which fields are required. |
| `email` | string | No | Email address of the customer |
| `phone` | string | No | Landline/office phone number |
| `title` | string | No | Customer title/salutation (e.g., Mr., Mrs., Dr.) |
| `active` | boolean | No | Whether the customer account is active (default: true) |
| `family` | object | No | Customer family/classification |
| `number` | string | No | Custom customer number/reference code |
| `lastName` | string | No | Last name - typically used when type is 'Individual' |
| `cellPhone` | string | No | Mobile/cell phone number |
| `firstName` | string | No | First name - typically used when type is 'Individual' |
| `internalId` | string | No | Your own unique identifier for this customer, useful for integration with external systems |
| `companyName` | string | No | Company name - required when type is 'Company' |
| `internalNotes` | string | No | Private internal notes about the customer |
| `billingAddress` | object | No | Address details |
| `billingOptions` | object | No | Billing options for the customer |
| `shippingAddress` | object | No | Address details |
| `companyInformations` | object | No | Company-specific information |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Family

**Slug:** `ALTOVIZ_CREATE_CUSTOMER_FAMILY`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | The name/label of the customer family for categorization |
| `number` | string | No | A unique reference number or code for the customer family |
| `internal_id` | string | No | Your internal reference ID for syncing with external systems |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `ALTOVIZ_CREATE_PRODUCT`

Creates a new product in the Altoviz system. This tool allows for the independent creation of a product with all necessary details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vat` | object | No | 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'} |
| `name` | string | Yes | Name of the product |
| `unit` | object | No | 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} |
| `active` | boolean | No | Whether the product is active and available for use |
| `family` | object | No | Product family/classification object for categorization. Must include: id and label fields |
| `number` | string | Yes | Unique product number or SKU identifier |
| `unit_price` | number | Yes | Selling price of the product (must be greater than 0) |
| `description` | string | Yes | Detailed description of the product |
| `internal_id` | string | No | Your internal reference ID for syncing with external systems |
| `product_type` | string ("Product" | "Service") | Yes | Type of item: 'Product' for physical goods, 'Service' for services |
| `internal_notes` | string | No | Private notes about the product (not visible to customers) |
| `purchase_price` | number | Yes | Cost/purchase price of the product (must be greater than 0) |
| `default_quantity` | number | No | Default quantity when adding product to invoices/quotes |
| `is_unit_price_tax_included` | boolean | No | True if unit_price includes VAT, False if price is before tax |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Family

**Slug:** `ALTOVIZ_CREATE_PRODUCT_FAMILY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | Yes | Label or name of the product family for categorization |
| `number` | string | No | Unique reference number or code for the product family |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Receipt

**Slug:** `ALTOVIZ_CREATE_RECEIPT`

Creates 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Sale Credit

**Slug:** `ALTOVIZ_CREATE_SALE_CREDIT`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Date of the credit note in YYYY-MM-DD format. If not provided, current date will be used. |
| `lines` | array | No | 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. |
| `region` | string ("FR" | "EU" | "IE" | "DOM" | "Corse" | "Monaco") | Yes | Tax region for this credit note. Must be one of: FR (France), EU (European Union), IE (Ireland), DOM (French overseas territories), Corse (Corsica), Monaco |
| `subject` | string | No | Subject/title for the credit note |
| `vatMode` | string ("Auto" | "Debit" | "Collection") | No | VAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment) |
| `vatNote` | string | No | VAT note to print on the credit note |
| `metadata` | object | No | Additional metadata as key-value pairs |
| `customerId` | integer | No | Customer ID to associate with this credit note. Either customerId or customerNumber must be provided. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs. |
| `internalId` | string | No | Your own internal reference ID for this credit note |
| `footerNotes` | string | No | Notes to print in the footer section of the credit note |
| `headerNotes` | string | No | Notes to print in the header section of the credit note |
| `liableToVat` | boolean | No | Indicates whether the document is liable to VAT |
| `customerName` | string | No | Customer name to display on the credit note |
| `internalNotes` | string | No | Internal notes (not printed on the credit note) |
| `billingAddress` | object | No | Billing address for the customer |
| `billingContact` | object | No | Billing contact information |
| `customerNumber` | string | No | Customer reference number. Either customerId or customerNumber must be provided. |
| `globalDiscount` | object | No | Global discount applied to the entire credit note |
| `shippingAmount` | number | No | Shipping amount to include in the credit note |
| `shippingAddress` | object | No | Shipping address for the customer |
| `shippingContact` | object | No | Shipping contact information |
| `vendorReference` | string | No | Vendor reference to be printed |
| `vatReverseCharge` | boolean | No | Set to true if VAT reverse charge applies |
| `customerVatNumber` | string | No | Customer's VAT registration number |
| `cancelledInvoicetId` | integer | No | ID of the invoice this credit note cancels/refunds |
| `useTaxIncludedPrices` | boolean | Yes | Set to true if prices include tax/VAT, false if prices are pre-tax amounts |
| `customerOrderReference` | string | No | Customer's order reference number |
| `cancelledInvoicetNumber` | string | No | Number of the invoice this credit note cancels/refunds |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Sale Invoice

**Slug:** `ALTOVIZ_CREATE_SALE_INVOICE`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Date of the invoice in YYYY-MM-DD format. If not provided, current date will be used. |
| `lines` | array | Yes | Line items for the invoice. At least one line item is required. |
| `region` | string ("FR" | "EU" | "IE" | "DOM" | "Corse" | "Monaco") | No | 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. |
| `subject` | string | No | Subject/title for the invoice |
| `vatMode` | string ("Auto" | "Debit" | "Collection") | No | VAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment) |
| `vatNote` | string | No | VAT note to print on the invoice |
| `metadata` | object | No | Additional metadata as key-value pairs |
| `customerId` | integer | Yes | Customer ID to associate with this invoice. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs. |
| `internalId` | string | No | Your own internal reference ID for this invoice |
| `footerNotes` | string | No | Notes to print in the footer section of the invoice |
| `headerNotes` | string | No | Notes to print in the header section of the invoice |
| `liableToVat` | boolean | No | Indicates whether the invoice is liable to VAT |
| `shippingVat` | object | No | VAT rate for shipping. Use ALTOVIZ_GET_VATS to retrieve available VAT rates. |
| `customerName` | string | No | Customer name to display on the invoice (overrides customer's name) |
| `internalNotes` | string | No | Internal notes (not printed on the invoice) |
| `billingAddress` | object | No | Billing address for the customer (overrides customer's default) |
| `billingContact` | object | No | Billing contact information |
| `customerNumber` | string | No | Customer reference number |
| `globalDiscount` | object | No | Global discount applied to the entire invoice |
| `shippingAmount` | number | No | Shipping amount to include in the invoice |
| `shippingAddress` | object | No | Shipping address for the customer (overrides customer's default) |
| `shippingContact` | object | No | Shipping contact information |
| `vendorReference` | string | No | Vendor reference to be printed |
| `vatReverseCharge` | boolean | No | Set to true if VAT reverse charge applies |
| `customerVatNumber` | string | No | Customer's VAT registration number |
| `useTaxIncludedPrices` | boolean | No | Set to true if prices include tax/VAT, false if prices are pre-tax amounts. If not provided, will use customer's default setting. |
| `customerOrderReference` | string | No | Customer's order reference number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Colleague

**Slug:** `ALTOVIZ_DELETE_COLLEAGUE`

Tool to delete a colleague from Altoviz. Use when you need to permanently remove a colleague from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Colleague id to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `ALTOVIZ_DELETE_CUSTOMER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | The unique identifier of the customer to delete. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs by email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Family

**Slug:** `ALTOVIZ_DELETE_CUSTOMER_FAMILY`

Tool to delete a customer family from Altoviz. Use when you need to permanently remove a customer family from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Customer family id to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product

**Slug:** `ALTOVIZ_DELETE_PRODUCT`

This tool allows you to delete an existing product from Altoviz. The action permanently removes the product from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique identifier of the product to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product Family

**Slug:** `ALTOVIZ_DELETE_PRODUCT_FAMILY`

Tool to delete a product family from Altoviz. Use when you need to permanently remove a product family from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Product family id to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Receipt

**Slug:** `ALTOVIZ_DELETE_RECEIPT`

Tool to delete a receipt from Altoviz. Use when you need to permanently remove a receipt from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_id` | integer | Yes | The unique identifier of the receipt to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Draft Sale Credit

**Slug:** `ALTOVIZ_DELETE_SALE_CREDIT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Draft credit ID to delete. Only draft credits can be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Sale Invoice

**Slug:** `ALTOVIZ_DELETE_SALE_INVOICE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | The unique identifier of the draft invoice to delete. Only draft invoices can be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Sale Quote

**Slug:** `ALTOVIZ_DELETE_SALE_QUOTE`

Tool to delete a sale quote from Altoviz. Use when you need to permanently remove a quote from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the sale quote to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Supplier

**Slug:** `ALTOVIZ_DELETE_SUPPLIER`

Tool to delete a supplier from Altoviz. Use when you need to permanently remove a supplier record from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `supplier_id` | integer | Yes | The unique identifier of the supplier to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Purchase Invoice

**Slug:** `ALTOVIZ_DOWNLOAD_PURCHASE_INVOICE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the purchase invoice to download |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Sale Credit PDF

**Slug:** `ALTOVIZ_DOWNLOAD_SALE_CREDIT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the sale credit to download |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Sale Invoice PDF

**Slug:** `ALTOVIZ_DOWNLOAD_SALE_INVOICE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the sale invoice to download |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Contact by Email

**Slug:** `ALTOVIZ_FIND_CONTACT`

This tool allows searching for contacts in Altoviz using an email address. The action is independently executable and returns contact details if found.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address to search for in contacts |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Customer by Email

**Slug:** `ALTOVIZ_FIND_CUSTOMER`

This tool allows you to find a customer in Altoviz by their email address. This is a standalone action that doesn't require any resource IDs or dependencies on other tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the customer to find |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Product by Number

**Slug:** `ALTOVIZ_FIND_PRODUCT`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_number` | string | Yes | The product number/SKU to search for. Supports partial matching - the search will return the first product whose number contains this value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Product by Number or Internal ID

**Slug:** `ALTOVIZ_FIND_PRODUCT_BY_NUMBER_OR_ID`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `number` | string | No | Product number/SKU for exact matching. At least one of 'number' or 'internal_id' must be provided. |
| `internal_id` | string | No | Internal ID used in your system. At least one of 'number' or 'internal_id' must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Receipt by Internal ID

**Slug:** `ALTOVIZ_FIND_RECEIPT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `internalId` | string | No | Customer internal ID to filter receipts. If not provided, returns all receipts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Sale Credits

**Slug:** `ALTOVIZ_FIND_SALE_CREDIT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `internalId` | string | No | Credit internal ID to filter by. If not provided, all credits will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Sale Invoices

**Slug:** `ALTOVIZ_FIND_SALE_INVOICE`

Tool to find sale invoices in Altoviz. Use when you need to search for or retrieve invoices. Can filter by internal ID or return all invoices if no filter is provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `internalId` | string | No | Invoice internal ID to filter by. If not provided, all invoices will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Sale Quotes

**Slug:** `ALTOVIZ_FIND_SALE_QUOTE`

Tool to find sale quotes in Altoviz. Use when you need to search for or retrieve quotations. Can filter by internal ID or return all quotes if no filter is provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `internalId` | string | No | Quote internal ID to filter by. If not provided, all quotes will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Classifications List

**Slug:** `ALTOVIZ_GET_CLASSIFICATIONS`

This 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("Sale" | "Expense" | "Other") | No | Filter classifications by type. Allowed values are 'Sale', 'Expense', or 'Other'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Colleague by ID

**Slug:** `ALTOVIZ_GET_COLLEAGUE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Colleague id to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact by ID

**Slug:** `ALTOVIZ_GET_CONTACT`

Tool to retrieve a contact by its unique ID from Altoviz. Use when you need to fetch detailed information about a specific contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the contact to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `ALTOVIZ_GET_CURRENT_USER`

Tool to retrieve the current authenticated user's information from Altoviz. Use when you need to get details about the currently authenticated user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer by ID

**Slug:** `ALTOVIZ_GET_CUSTOMER`

Tool to retrieve a customer by their ID from Altoviz. Use when you need detailed information about a specific customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Customer ID to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer by Internal ID

**Slug:** `ALTOVIZ_GET_CUSTOMER_BY_INTERNAL_ID`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `internal_id` | string | Yes | The internal ID of the customer to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Contacts

**Slug:** `ALTOVIZ_GET_CUSTOMER_CONTACTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Customer ID to retrieve contacts for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Family

**Slug:** `ALTOVIZ_GET_CUSTOMER_FAMILY`

Tool to retrieve a customer family by ID from Altoviz. Use when you need to fetch details of a specific customer family.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Customer family id to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product by ID

**Slug:** `ALTOVIZ_GET_PRODUCT`

Tool to retrieve a product by its unique ID in Altoviz. Use when you need complete details about a specific product including pricing, VAT, units, and inventory information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Product ID to retrieve. This is the unique identifier of the product in Altoviz. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Family by ID

**Slug:** `ALTOVIZ_GET_PRODUCT_FAMILY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Product family ID to retrieve. Must be a valid product family identifier from your Altoviz account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Receipt by ID

**Slug:** `ALTOVIZ_GET_RECEIPT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Receipt id to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sale Credit by ID

**Slug:** `ALTOVIZ_GET_SALE_CREDIT`

Tool to retrieve a sale credit by its ID from Altoviz. Use when you need to get detailed information about a specific credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Credit ID to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sale Invoice by ID

**Slug:** `ALTOVIZ_GET_SALE_INVOICE`

Tool to retrieve a sale invoice by its ID from Altoviz. Use when you need to get detailed information about a specific invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Invoice ID to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Settings

**Slug:** `ALTOVIZ_GET_SETTINGS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supplier by ID

**Slug:** `ALTOVIZ_GET_SUPPLIER`

Tool to retrieve a supplier by their ID from Altoviz. Use when you need detailed information about a specific supplier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Supplier ID to retrieve. This is the unique identifier of the supplier in Altoviz. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supplier Contacts

**Slug:** `ALTOVIZ_GET_SUPPLIER_CONTACTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Supplier ID to retrieve contacts for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Units List

**Slug:** `ALTOVIZ_GET_UNITS`

This tool retrieves a list of all available units in the Altoviz system. Units are used for product measurements and quantity specifications in various transactions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get VAT Rates

**Slug:** `ALTOVIZ_GET_VATS`

This tool retrieves a list of all available VAT rates from Altoviz. It's essential for creating and managing invoices and quotes where VAT calculations are required. It supports retrieving VAT rates, validating them for different regions, and ensuring correct tax calculations in financial documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Colleagues

**Slug:** `ALTOVIZ_LIST_COLLEAGUES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | 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. |
| `order_by` | string | No | Field name to sort the results by. Common values include 'name', 'lastName', 'firstName', 'number'. Append ' desc' for descending order (e.g., 'name desc'). |
| `page_size` | integer | No | The number of colleagues to return per page. Use this with page_index to control pagination. Typical values are 10, 20, 50, or 100. |
| `page_index` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `ALTOVIZ_LIST_CONTACTS`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Families

**Slug:** `ALTOVIZ_LIST_CUSTOMER_FAMILIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Full text search query to filter customer families. Use this to search across all customer family fields. |
| `OrderBy` | string | No | Field name to order the results by. Use this to sort the customer families list. |
| `PageSize` | integer | No | The number of customer families to return per page. Use this to control the size of the result set. |
| `PageIndex` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `ALTOVIZ_LIST_CUSTOMERS`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Families

**Slug:** `ALTOVIZ_LIST_PRODUCT_FAMILIES`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receipts

**Slug:** `ALTOVIZ_LIST_RECEIPTS`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sale Credits

**Slug:** `ALTOVIZ_LIST_SALE_CREDITS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `To` | string | No | Filter credits up to this date (inclusive). Format: YYYY-MM-DD. |
| `From` | string | No | Filter credits from this date onwards (inclusive). Format: YYYY-MM-DD. |
| `OrderBy` | string | No | The field to order results by. Common values include 'date', 'number', 'customerName'. |
| `PageSize` | integer | No | The number of items to return per page. Recommended range is 1-100. |
| `PageIndex` | integer | No | The page index for pagination (zero-based). Use this to navigate through multiple pages of results. |
| `CustomerId` | integer | No | Filter credits by specific customer ID. Only credits for this customer will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sale Invoices

**Slug:** `ALTOVIZ_LIST_SALE_INVOICES`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sale Quotes

**Slug:** `ALTOVIZ_LIST_SALE_QUOTES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `To` | string | No | Filter quotes up to this date (inclusive). Format: YYYY-MM-DD. |
| `From` | string | No | Filter quotes from this date onwards (inclusive). Format: YYYY-MM-DD. |
| `OrderBy` | string | No | The field to order results by. Common values include 'date', 'number', 'customerName'. |
| `PageSize` | integer | No | The number of items to return per page. Recommended range is 1-100. |
| `PageIndex` | integer | No | The page index for pagination (zero-based). Use this to navigate through multiple pages of results. |
| `CustomerId` | integer | No | Filter quotes by specific customer ID. Only quotes for this customer will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Suppliers

**Slug:** `ALTOVIZ_LIST_SUPPLIERS`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `ALTOVIZ_LIST_WEBHOOKS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Register Webhook

**Slug:** `ALTOVIZ_REGISTER_WEBHOOK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Webhook URL where events will be sent (must be a valid HTTPS endpoint) |
| `name` | string | Yes | Name of the webhook for identification purposes |
| `types` | array | Yes | List of event types that will trigger this webhook. Select one or more events to monitor. |
| `secret_key` | string | No | Optional secret key for webhook authentication and signature verification |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test API Key

**Slug:** `ALTOVIZ_TEST_API_KEY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_version` | string | No | Optional API version parameter to use for the request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unregister Webhook

**Slug:** `ALTOVIZ_UNREGISTER_WEBHOOK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Webhook ID to unregister. Either id or url must be provided. |
| `url` | string | No | Webhook URL to unregister. Either id or url must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Colleague Information

**Slug:** `ALTOVIZ_UPDATE_COLLEAGUE`

Updates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the colleague to update |
| `name` | string | No | Full name of the colleague |
| `email` | string | No | Email address of the colleague |
| `phone` | string | No | Phone number of the colleague |
| `title` | string | No | Title or position of the colleague |
| `number` | string | No | Colleague number/reference code |
| `user_id` | string | No | User identifier associated with the colleague |
| `last_name` | string | No | Last name of the colleague |
| `metadatas` | object | No | Metadata associated with the colleague as key-value pairs |
| `cell_phone` | string | No | Cell phone number of the colleague |
| `first_name` | string | No | First name of the colleague |
| `is_partner` | boolean | No | Indicates if the colleague is a partner |
| `internal_id` | string | No | Internal identifier for the colleague, useful for integration with external systems |
| `homecare_service_number` | string | No | Homecare service number associated with the colleague |
| `initial_partner_balance` | number | No | Initial balance for the partner (if the colleague is a partner) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Information

**Slug:** `ALTOVIZ_UPDATE_CUSTOMER`

Updates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Customer's email address |
| `phone` | string | No | Customer's landline/office phone number |
| `title` | string | No | Customer's title/salutation |
| `last_name` | string | No | Customer's last name. Required for Individual-type customers when company_name is not set. |
| `cell_phone` | string | No | Customer's mobile/cell phone number |
| `first_name` | string | No | Customer's first name (for Individual-type customers) |
| `customer_id` | string | Yes | The unique Altoviz customer ID. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs by email. |
| `internal_id` | string | No | Your own unique identifier for this customer, useful for integration with external systems |
| `company_name` | string | No | Company name. Required for Company-type customers. Setting this changes customer type to Company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Receipt

**Slug:** `ALTOVIZ_UPDATE_RECEIPT`

Updates an existing receipt in Altoviz. Only fields that are provided will be updated; omitted fields retain their current values. Use this to modify receipt details such as amount, date, payment method, status, or notes.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Sale Credit

**Slug:** `ALTOVIZ_UPDATE_SALE_CREDIT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Credit ID to update. Use ALTOVIZ_FIND_SALE_CREDIT to look up credit IDs. |
| `date` | string | No | Date of the credit note in YYYY-MM-DD format |
| `lines` | array | No | Line items for the credit note. Each line should include fields like productId, quantity, price, description, etc. |
| `region` | string ("FR" | "EU" | "IE" | "DOM" | "Corse" | "Monaco") | No | Tax region for this credit note. Must be one of: FR (France), EU (European Union), IE (Ireland), DOM (French overseas territories), Corse (Corsica), Monaco |
| `isDraft` | boolean | No | Set to true to keep as draft, false to finalize. Only draft credits can be modified. |
| `subject` | string | No | Subject/title for the credit note |
| `vatMode` | string ("Auto" | "Debit" | "Collection") | No | VAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment) |
| `vatNote` | string | No | VAT note to print on the credit note |
| `metadata` | object | No | Additional metadata as key-value pairs |
| `customerId` | integer | No | Customer ID to associate with this credit note |
| `internalId` | string | No | Your own internal reference ID for this credit note |
| `footerNotes` | string | No | Notes to print in the footer section of the credit note |
| `headerNotes` | string | No | Notes to print in the header section of the credit note |
| `liableToVat` | boolean | No | Indicates whether the document is liable to VAT |
| `shippingVat` | object | No | Shipping VAT details |
| `customerName` | string | No | Customer name to display on the credit note |
| `internalNotes` | string | No | Internal notes (not printed on the credit note) |
| `billingAddress` | object | No | Billing address for the customer |
| `billingContact` | object | No | Billing contact information |
| `customerNumber` | string | No | Customer reference number |
| `globalDiscount` | object | No | Global discount applied to the entire credit note |
| `shippingAmount` | number | No | Shipping amount to include in the credit note |
| `shippingAddress` | object | No | Shipping address for the customer |
| `shippingContact` | object | No | Shipping contact information |
| `vendorReference` | string | No | Vendor reference to be printed |
| `vatReverseCharge` | boolean | No | Set to true if VAT reverse charge applies |
| `customerVatNumber` | string | No | Customer's VAT registration number |
| `cancelledInvoicetId` | integer | No | ID of the invoice this credit note cancels/refunds |
| `useTaxIncludedPrices` | boolean | No | Set to true if prices include tax/VAT, false if prices are pre-tax amounts |
| `customerOrderReference` | string | No | Customer's order reference number |
| `cancelledInvoicetNumber` | string | No | Number of the invoice this credit note cancels/refunds |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Supplier Information

**Slug:** `ALTOVIZ_UPDATE_SUPPLIER`

Updates an existing supplier's information in Altoviz. Only fields that are provided will be updated; omitted fields retain their current values. Use this when you need to modify supplier details such as contact information, address, payment terms, or internal notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique Altoviz supplier ID to update |
| `name` | string | No | Company name of the supplier |
| `email` | string | No | Supplier's email address |
| `phone` | string | No | Supplier's phone number |
| `title` | string | No | Title/salutation for the supplier contact |
| `number` | string | No | Supplier reference number |
| `address` | object | No | Supplier's address information |
| `last_name` | string | No | Last name of the supplier contact person |
| `cell_phone` | string | No | Supplier's mobile/cell phone number |
| `first_name` | string | No | First name of the supplier contact person |
| `internal_id` | string | No | Your own unique identifier for this supplier, useful for integration with external systems |
| `internal_notes` | string | No | Private notes about the supplier (not visible to supplier) |
| `company_informations` | object | No | Company registration information (SIRET, VAT number) |
| `default_payment_method` | string ("Transfer" | "Order" | "Check" | "Cash" | "Card" | "Bill" | "Usec" | "Other") | No | Default payment method for this supplier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Purchase Invoice

**Slug:** `ALTOVIZ_UPLOAD_PURCHASE_INVOICE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The purchase invoice file to upload (PDF or image format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |