Reference

Test API Key

Verifies that your API key is valid and returns basic account information, allowing you to quickly confirm connectivity before performing other operations.

Get Classifications List

Retrieves accounting classifications used to organize invoices and produce financial registers for reporting and compliance.

Delete Colleague

Permanently removes a colleague's account and access from the Altoviz accounting system, ensuring only current team members can view or manage financial data.

Get Colleague by ID

Retrieves detailed information about a specific colleague, including their contact details, partner status, and metadata, enabling you to access or verify their record instantly.

List Colleagues

Retrieves a list of colleagues in your Altoviz account, with options to search, sort, and paginate results for easy navigation.

Update Colleague Information

Updates specific fields of an existing colleague's record in Altoviz, leaving other fields unchanged. Use this to keep colleague information accurate and up-to-date without recreating records.

Create Contact

Adds a new person or company record (name, email, phone, company) to your Altoviz contact database, enabling you to organize relationships for sales, billing, and communication.

Find Contact by Email

Searches for a contact in Altoviz by their email address and returns the associated contact details, enabling quick lookups without manual browsing.

Get Contact by ID

Retrieves detailed information about a specific contact using their unique identifier. Useful for quickly viewing or updating a contact's complete profile without searching through your entire contact list.

Get Customer Contacts

Retrieves all contact records associated with a specific customer, providing their phone numbers, emails, and other details for follow-up or communication.

Get Supplier Contacts

Retrieves all contact records linked to a specific supplier, making it easy to find the right person to reach out to for orders, payments, or issue resolution.

List Contacts

Retrieves a paginated, filterable list of all contacts stored in Altoviz, allowing you to browse, search, or export customer and vendor records.

Create Sale Credit

Creates a draft credit note to cancel or refund an invoice, allowing modifications before finalizing.

Delete Draft Sale Credit

Permanently removes a draft credit note that has not been finalized, allowing you to clean up errors or unwanted entries before they are issued.

Download Sale Credit PDF

Retrieves the PDF version of a sale credit (credit note) from your accounting records, enabling you to share, print, or archive the document for customer communication and record-keeping.

Find Sale Credits

Retrieve credit notes (sale credits) from Altoviz, with optional filtering by internal ID, to review or manage issued credits efficiently

Get Sale Credit by ID

Retrieves the full details of a specific sale credit (such as a refund or credit note) by its unique identifier, allowing you to review amounts, items, and status for accounting or customer service purposes.

List Sale Credits

Retrieves a list of credit notes issued to customers, allowing you to filter by date or customer for quick access to refund or adjustment records.

Update Sale Credit

Modifies an existing draft credit note in Altoviz to adjust amounts, items, or details before finalizing.

Create Customer Family

Creates a customer family to group customers into meaningful segments, making it easier to manage pricing, communications, and reporting across different customer types

Delete Customer Family

Permanently removes a customer family from Altoviz, helping to keep your customer categorization structure tidy and up-to-date.

Get Customer Family

Fetches the details of a specific customer family (group) in Altoviz, enabling you to view its attributes and associated members.

List Customer Families

Retrieves a list of customer family groups from your account, allowing you to search, filter, and organize your customer base by category.

Create Customer

Creates a new customer record in Altoviz, supporting both business (Company) and individual (Personal) customer types by capturing the appropriate name details.

Find Customer by Email

Locates an existing customer record in Altoviz using their email address, allowing you to quickly access their account details for follow-ups, updates, or verification.

Delete Customer

Permanently removes a customer record from Altoviz, helping maintain an accurate and up-to-date customer database.

Get Customer by ID

Fetches detailed information for a specific customer using their unique identifier, enabling you to view or update their records in your accounting system.

Get Customer by Internal ID

Retrieves detailed information about a specific customer using their unique internal identifier, enabling you to access their full profile, contact data, and transaction history for personalized service or follow-up.

List Customers

Retrieves a paginated list of customers, with the ability to search by name, email, or company and sort the results.

Update Customer Information

Updates specific fields of an existing customer record in Altoviz, leaving other fields unchanged.

Create Sale Invoice

Creates a new draft sale invoice in Altoviz with line items, ready for review and finalization before sending to a customer.

Download Sale Invoice PDF

Retrieves the PDF file of a specific sale invoice from Altoviz, enabling you to save, print, or share the invoice document for client communication and record keeping.

List Sale Invoices

Retrieves a filtered list of sale invoices issued to customers, allowing you to view, sort, and paginate through invoices by date range, status, or specific customer.

Delete Sale Invoice

Permanently removes a draft sale invoice from Altoviz, helping you correct errors or clean up unnecessary drafts before they are finalized.

Find Sale Invoices

Searches for and retrieves sale invoices, optionally filtered by ID or other criteria, to help you track and manage your sales records

Get Sale Invoice by ID

Retrieves the full details of a specific sale invoice by its unique identifier, enabling you to view line items, totals, and payment status for customer service or reconciliation.

Create Product Family

Creates a product family to group related items, enabling better organization and streamlined inventory management for your business.

Delete Product Family

Permanently removes a product family and all its associated products from your Altoviz catalog, helping you clean up outdated or duplicate groupings.

Get Product Family by ID

Retrieves the details of a specific product family (category) by its unique identifier, allowing you to view or reference its attributes for inventory management and reporting.

List Product Families

Retrieves all product families, allowing you to browse and organize your products for better categorization and inventory management.

Create Product

Adds a new product or service to your Altoviz catalog, allowing you to define pricing, inventory, and tax settings for sales, invoicing, and order management.

Find Product by Number

Retrieves complete product details including name, pricing, and tax information by searching with its SKU or product number, enabling quick verification before transactions.

Delete Product

Permanently removes a product from your Altoviz inventory, allowing you to clean up discontinued or obsolete items and keep your catalog organized.

Find Product by Number or Internal ID

Retrieves a product from Altoviz using either its product number (SKU) or your internal system ID. Useful for quickly looking up product details when you have a known identifier.

Get Product by ID

Retrieves complete details for a specific product in Altoviz, including pricing, VAT, units, and inventory information, allowing you to view or reference the full product record.

Download Purchase Invoice

Downloads the PDF version of a specific purchase invoice stored in your Altoviz account, allowing you to access the original document for record-keeping or sharing.

Upload Purchase Invoice

Uploads a PDF or image of a supplier invoice to automatically create a purchase invoice record in your accounting system, saving time by eliminating manual data entry for bills received from vendors.

Delete Sale Quote

Permanently removes a sales quote from your accounting system, helping you eliminate outdated, duplicate, or erroneous records and maintain a clean quotes list.

Find Sale Quotes

Searches for and retrieves sales quotations in Altoviz, either by a specific internal ID or as a complete list, enabling quick access to customer quotes for follow-up, reporting, or order processing.

List Sale Quotes

Retrieves a list of sale quotes from Altoviz, with options to filter by customer or date range, sort results, and paginate for efficient access.

Create Receipt

Records a customer payment in Altoviz, optionally linking it to an invoice or other document to keep your accounting up to date.

Delete Receipt

Permanently removes a receipt from your Altoviz accounting records, helping you correct mistakes or eliminate outdated entries.

Find Receipt by Internal ID

Locates receipts associated with a specific customer internal ID, enabling quick retrieval of payment records for a particular client.

Get Receipt by ID

Retrieves the full details of a specific receipt, including amount, payment method, status, and customer information, to verify or reference a transaction.

List Receipts

Retrieves a list of receipts with options to search, filter, and sort them, helping you quickly find specific receipts, review recent transactions, or organize your accounting records.

Update Receipt

Updates specific fields of an existing receipt, such as the amount, date, payment method, status, or notes, while leaving all other fields unchanged. This allows you to correct errors or adjust receipt details without recreating the entry.

Get Settings

Retrieves application configuration settings for accounting, company information, emailing, sales, social media, and VAT to access or verify your Altoviz setup.

Delete Supplier

Permanently removes a supplier record from your Altoviz accounting system, helping you maintain an accurate and clutter-free vendor list.

Get Supplier by ID

Fetches detailed information about a specific supplier from your Altoviz database, allowing you to view their contact info, payment terms, and transaction history at a glance.

List Suppliers

Retrieves a paginated, searchable list of all suppliers in your Altoviz account, enabling you to browse, filter, or export supplier records for management and reporting.

Update Supplier Information

Updates existing supplier details in Altoviz, modifying only the fields you specify while leaving others unchanged. Ideal for keeping supplier contact information, payment terms, or notes current without re-entering all data.

Get Units List

Retrieves the list of all measurement units defined in your Altoviz system, such as pieces, kilograms, or liters, which are used for product quantities and transactions.

Get Current User

Retrieves details about the currently authenticated user in Altoviz, such as name, email, and role, to personalize the experience or validate permissions.

Get VAT Rates

Retrieves all available VAT rates from Altoviz to ensure accurate tax calculations on invoices and quotes.

List Webhooks

Retrieves a list of all configured webhooks, including their URLs, event types, and authentication details, so you can review or audit your event notification setup.

Register Webhook

Registers a webhook endpoint to receive real-time event notifications from Altoviz, such as customer creation, invoice updates, or product changes.

Unregister Webhook

Removes a previously registered webhook from Altoviz, stopping automated notifications and data updates sent to a specific URL.