evoliz MCP

Get detailed information about the authenticated user's current company (FR: Entreprise/Société). A company (FR: entreprise, société) is the business entity that owns the Evoliz account and manages invoices, quotes, clients, etc. Returns comprehensive company details including: - Company identification (ID, code, name) - Contact information (email, phone) - Legal status - Address - Accounting period - Payment terms No parameters required - automatically uses the authenticated user's company.

List users (FR: Utilisateurs) in the authenticated user's company. A user (FR: utilisateur) is a person who has access to the Evoliz account with specific permissions and roles. Returns a paginated list of users with their details including: - User ID, firstname, lastname - Profile type (user, admin, etc.) - Email, phone, mobile, fax - Role (CTO, etc.) - Creation date and last connection - Active/inactive status Optional filters: - enabled: Filter active (true) or inactive (false) users - search: Search users by name, email, etc. - per_page: Number of results per page (1-100, default: 15) Example usage: - List all users: {} - List active users only: {"enabled": true} - Search for specific user: {"search": "francois"} - Get 50 users per page: {"per_page": 50}

Get detailed information about a specific user (FR: Utilisateur) by its ID. A user (FR: utilisateur) is a person who has access to the Evoliz account with specific permissions and roles. Returns comprehensive user details including: - User ID, firstname, lastname - Profile type (user, admin, etc.) - Email, phone, mobile, fax - Role - Creation date and last connection Required parameter: - userid: The unique identifier of the user to retrieve

Create a new admin user (FR: Utilisateur administrateur) in the company. A user (FR: utilisateur) is a person who has access to the Evoliz account with specific permissions and roles. Optional parameters: - firstname: User first name - lastname: User last name - email: User email address - email_notification: Send an email notification for the user creation (default: true) The API will create the admin user and optionally send a notification email. Example usage: { "firstname": "François", "lastname": "Aupetit", "email": "contact@triiptic.fr", "email_notification": true } Example minimal usage: { "firstname": "John", "lastname": "Doe", "email": "john.doe@example.com" } Note: By default, an email notification will be sent unless email_notification is set to false.

List clients (FR: Clients) in the authenticated user's company. A client (FR: client) is a customer or business entity that purchases goods or services from your company. Returns a paginated list of clients with comprehensive details including: - Client identification (ID, code, name, type, legal form) - Business numbers (SIRET, SIREN, VAT number, etc.) - Bank information (IBAN, BIC, bank name, account details) - Address and delivery address - Contact information (phone, mobile, fax, website) - Payment terms and conditions - Safe amount, rebate percentages - Custom fields - Active/inactive status Optional filters: - enabled: Filter active (true) or inactive (false) clients - search: Search clients by name, code, email, etc. - per_page: Number of results per page (1-100, default: 50) Example usage: - List all clients: {} - List active clients only: {"enabled": true} - Search for specific client: {"search": "Triiptic"} - Get 100 clients per page: {"per_page": 100}

Get detailed information about a specific client (FR: Client) by its ID. A client (FR: client) is a customer or business entity that purchases goods or services from your company. Returns comprehensive client details including: - Client identification (ID, code, name, type, legal form) - Business numbers (SIRET, SIREN, VAT number) - Bank information - Address and delivery address - Contact information - Payment terms Required parameter: - clientid: The unique identifier of the client to retrieve

Create a new client (FR: Client) with given data. A client (FR: client) is a customer or business entity that purchases goods or services from your company. Required fields: - name: Client name - type: Client type (Particulier, Professionnel, or Administration publique) - address: Client address information (object with addr, postcode, town, iso2) Optional fields include code, legal form, business numbers, bank information, delivery address, contact details, payment terms, custom fields, etc. The API will validate all data and return the created client with its ID. Example minimal usage: { "name": "Triiptic", "type": "Professionnel", "address": { "addr": "176 avenue Joseph Louis Lambot", "postcode": "83130", "town": "La Garde", "iso2": "FR" } } Example with full details: { "name": "Triiptic SAS", "type": "Professionnel", "code": "C00123", "legalform": "SAS", "business_number": "123 456 789 12345", "business_identification_number": "123 456 789", "vat_number": "FR20123456789", "address": { "addr": "176 avenue Joseph Louis Lambot", "addr2": "Etage 2", "postcode": "83130", "town": "La Garde", "iso2": "FR" }, "phone": "01 46 72 50 04", "website": "https://www.triiptic.fr", "safe_amount": 4000, "ttc": false } Notes: - If code is not provided, it will be automatically generated - For French clients of type Professionnel or Administration publique: vat_number is REQUIRED - Set vat_number to 'N/C' if Not Concerned, Not Known or Not Communicated

Update an existing client (FR: Client) with given data. A client (FR: client) is a customer or business entity that purchases goods or services from your company. Only provided fields will be updated (partial update). Required parameters: - clientid: The client ID to update Optional fields (all nullable): - code, name, civility, type, legalform - activity_number, immat_number - business_number, business_identification_number, vat_number - bank_information, address - phone, mobile, fax, website - safe_amount, term, ttc - comment - enabled (activate/deactivate client) Note: For term and ttc fields, use the format: { "enabled": true, "value": <actual_value> } Example minimal usage: { "clientid": 9876, "name": "Triiptic SAS Updated" } Example with multiple fields: { "clientid": 9876, "name": "Triiptic SAS", "phone": "01 46 72 50 05", "website": "https://www.triiptic.com", "safe_amount": 5000, "enabled": true } Example with term update: { "clientid": 9876, "term": { "penalty": { "enabled": true, "value": 5 }, "rebate_percent": { "enabled": true, "value": 10 } } }

List client contacts (FR: Contacts clients) in the company. A client contact is a person associated with a client company (e.g., CEO, accountant, sales rep). Returns contact details including: - Contact identification (ID, name, civility) - Associated client information - Email and phone numbers (primary, secondary, tertiary) - Job profile/function - Consent status (GDPR) - Favorite flag Optional filters: - clientid: Filter by specific client ID - enabled: Filter active/inactive contacts - consent: Filter by consent status (without, authorized, unauthorized) - search: Search by name, email - email: Filter by email address Example usage: { "clientid": 9876, "enabled": true }

Get detailed information about a specific client contact by its ID. Returns full contact details including: - Contact info (name, civility, email, profile/job) - Associated client information - Phone numbers (primary, secondary, tertiary with labels) - Consent status and favorite flag - Custom fields Required parameter: - contactid: The contact ID to retrieve Example usage: { "contactid": 8568 }

Create a new contact for a client. The client must be enabled (active): contacts of a disabled client are read-only. Required fields: - clientid: The client to attach the contact to - lastname: Contact last name - email: Contact email address Optional fields: - civility: Contact civility - firstname: Contact first name - profil: Job/function - consent: GDPR consent status - Phone numbers (primary, secondary, tertiary) with labels - favorite: Set as client's favorite contact Phone label values: see the label_tel_* parameter enums (e.g., "Portable", "Principal"). Example usage: { "clientid": 9876, "lastname": "Gasquet", "firstname": "Olivier", "email": "contact@triiptic.fr", "profil": "CTO", "label_tel_primary": "Portable", "tel_primary": "+33600000000" }

Update an existing client contact with given data (PATCH). Only provided fields will be updated. The contact's client must be enabled (active): contacts of a disabled client are read-only. Required parameter: - contactid: The contact ID to update Updatable fields: - civility, lastname, firstname, profil, email - consent: GDPR consent status - Phone numbers and labels - favorite: Set as client's favorite - enabled: Activate/deactivate contact Example usage: { "contactid": 8568, "profil": "CEO", "tel_primary": "+33100000000" }

List addresses (FR: Adresses) for a specific client. Client addresses are delivery/shipping addresses associated with a client. Each client can have multiple addresses with one marked as favorite. Returns address details including: - Address identification (ID, name, code) - Full address (addr, addr2, addr3, postcode, town, country) - Business number for the address - Favorite flag Optional filters: - clientid: Only list the addresses of this client - search: Search by name, code, or address - code, country_iso2, type, enabled Example usage: { "clientid": 9876 }

Get detailed information about a specific client address by its ID. Returns full address details including: - Address identification (ID, name, code) - Full address (addr, addr2, addr3, postcode, town, country) - Business number for the address - Favorite flag - Associated client information Required parameter: - addressid: The address ID to retrieve Example usage: { "addressid": 1234 }

Create a new address for a client. Client addresses are delivery/shipping addresses that can be used on invoices and quotes. Required fields: - clientid: The client to attach the address to - name: Address name/label - type: Address type (currently only "delivery") - postcode: Postal code - town: City/Town - iso2: Country ISO2 code (e.g., FR, US, DE) Optional fields: - code: Address code (auto-generated if not provided) - addr, addr2, addr3: Street address lines - business_number: Business number for this location - favorite: Set as client's favorite address Note: addr (first address line) is REQUIRED when the company has enabled electronic invoicing, optional otherwise. Example usage: { "clientid": 9876, "name": "Entrepôt Lyon", "type": "delivery", "addr": "45 rue de la Logistique", "postcode": "69001", "town": "Lyon", "iso2": "FR", "favorite": true }

Update an existing client address with given data (PATCH). Only provided fields will be updated. Required parameter: - addressid: The address ID to update Updatable fields: - name, code: Address identification - addr, addr2, addr3: Street address lines - postcode, town, iso2: Location details - business_number: Business number for this location - favorite: Set as client's favorite address - enabled: Activate/deactivate the address Note: when the company has enabled electronic invoicing, addr (first address line) cannot be blanked out — omit it or provide a non-empty value. Example usage: { "addressid": 1234, "name": "Nouveau Entrepôt", "favorite": true }

List prospects (FR: Prospects) in the authenticated user's company. A prospect (FR: prospect) is a potential customer who has not yet made a purchase. Prospects can be converted to clients using ProspectTransformTool. Returns a paginated list of prospects with: - Prospect identification (ID, name) - Business numbers (SIRET, VAT number, activity number) - Address and contact information - Comments and custom fields - Active/inactive status Optional filters: - enabled: Filter active (true) or inactive (false) prospects - search: Search by name, email, etc. - country_iso2: Filter by country (ISO2 code) - userid: Filter by creator ID Example usage: { "search": "Triiptic", "enabled": true }

Get detailed information about a specific prospect (FR: Prospect) by its ID. Returns comprehensive prospect details including: - Basic info (name, business numbers) - Address information - Contact details (phone, mobile, fax, website) - Comments and custom fields Required parameter: - prospectid: The prospect ID to retrieve Example usage: { "prospectid": 12345 }

Create a new prospect (FR: Prospect) with given data. A prospect is a potential customer who has not yet made a purchase. Prospects can later be converted to clients using ProspectTransformTool. Required fields: - name: Prospect name (must be unique) - type: Prospect type (Particulier, Professionnel or Administration publique) - address: Address object with postcode, town, and iso2 Optional fields: - business_number: SIRET number (required for French prospects of type Administration publique) - activity_number: APE/NAF code - vat_number: Intra-community VAT number (required for French prospects of type Professionnel or Administration publique) - phone, mobile, fax, website - comment: Comments on the prospect Example usage: { "name": "Acme Corp", "type": "Professionnel", "address": { "addr": "123 Main Street", "postcode": "75001", "town": "Paris", "iso2": "FR" }, "phone": "+33 1 23 45 67 89" }

Transform a prospect (FR: Prospect) into a client (FR: Client). CRITICAL: This action is IRREVERSIBLE — the prospect is permanently deleted after the transformation and cannot be restored. NEVER call this tool without the user's explicit confirmation. This converts a prospect into a full client. The transformation: - Creates a new client with all prospect data - Transforms all prospect contacts into client contacts - Links all related entities (quotes, etc.) to the new client - The prospect is deleted after successful transformation Required parameter: - prospectid: The prospect ID to transform Returns the newly created client data. Example usage: { "prospectid": 12345 }

List prospect contacts (FR: Contacts prospects) in the company. A prospect contact is a person associated with a prospect company (e.g., CEO, accountant, sales rep). Returns contact details including: - Contact identification (ID, name, civility) - Associated prospect information - Email and phone numbers (primary, secondary, tertiary) - Job profile/function - Consent status (GDPR) - Favorite flag Optional filters: - prospectid: Filter by specific prospect ID - enabled: Filter active/inactive contacts - consent: Filter by consent status (without, authorized, unauthorized) - search: Search by name, email - email: Filter by email address Example usage: { "prospectid": 9876, "enabled": true }

Get detailed information about a specific prospect contact by its ID. Returns full contact details including: - Contact info (name, civility, email, profile/job) - Associated prospect information - Phone numbers (primary, secondary, tertiary with labels) - Consent status and favorite flag - Custom fields Required parameter: - contactid: The contact ID to retrieve Example usage: { "contactid": 8568 }

Create a new contact for a prospect. Required fields: - prospectid: The prospect to attach the contact to - lastname: Contact last name Optional fields: - email: Contact email address - civility: Contact civility - firstname: Contact first name - profil: Job/function - consent: GDPR consent status - Phone numbers (primary, secondary, tertiary) with labels - favorite: Set as prospect's favorite contact Phone label values: see the label_tel_* parameter enums (e.g., "Portable", "Principal"). Example usage: { "prospectid": 9876, "lastname": "Martin", "firstname": "Sophie", "email": "sophie.martin@prospect.fr", "profil": "Directrice Achats", "label_tel_primary": "Portable", "tel_primary": "+33600000000" }

List suppliers (FR: Fournisseurs) of the current user company. A supplier (FR: fournisseur) is a company or person from whom you purchase goods or services. Returns supplier details including: - Supplier identification (ID, code, name) - Legal information (legal form, business number, VAT number) - Address and contact info (phone, mobile, fax, website) - Bank information (IBAN, BIC) - Default values (payment terms, payment type, analytic) - Custom fields - Enabled state Optional filters: - per_page: Pagination (1-100, default: 15) - country_iso2: Filter by country ISO2 code - enabled: Filter active/inactive suppliers - search: Search parameter - code: Filter by supplier code - sort_by, order: Sorting options Example usage: - List all suppliers: {} - Filter active suppliers: {"enabled": true} - Search: {"search": "Triiptic"} - Filter by code: {"code": "F160"}

Get detailed information about a specific supplier (FR: Fournisseur) by its ID. Returns full supplier details including: - Supplier identification (ID, code, name, creator user ID) - Legal form and business numbers (SIRET, APE/NAF, VAT number) - Bank information (account details, IBAN, BIC) - Full address (street, postal code, town, country) - Contact info (phone, mobile, fax, website) - Comments - Enabled state - Custom fields - Default values (payment terms, payment type, analytic axis) Required parameter: - supplierid: The supplier ID to retrieve Example usage: { "supplierid": 9876 }

Create a new supplier (FR: Fournisseur) with given data. A supplier (FR: fournisseur) is a company or person from whom you purchase goods or services. Required field: - name: Supplier name Optional fields: - code: Supplier code (auto-generated if not provided) - legalform: Legal form (e.g., SAS, SARL) - activity_number: Activity code (APE/NAF) - business_number: SIRET number - vat_number: Intra-community VAT number (use "N/C" if not applicable) - bank_information: Bank details (IBAN, BIC, account details) - address: Full address (addr, postcode, town, iso2) - phone, mobile, fax: Phone numbers - website: Website URL - default_values: Default payment terms (paytermid, paytypeid, analyticid) - comment: Comments - purchase_classifications: Default purchase classification IDs Example minimal usage: { "name": "Triiptic" } Example with full details: { "name": "Triiptic SAS", "code": "F160", "legalform": "SAS", "business_number": "123 456 789 12345", "vat_number": "FR20123456789", "address": { "addr": "176 avenue Joseph Louis Lambot", "postcode": "83130", "town": "La Garde", "iso2": "FR" }, "phone": "01 46 72 50 04", "website": "https://www.triiptic.fr", "default_values": { "paytermid": 3, "paytypeid": 3 } }

List buys (FR: Achats) visible by the current user, according to visibility restrictions set in user profile. A buy (FR: achat) is a purchase document (supplier invoice or expense report) recorded on the company. Returns a paginated list of compact summary rows: buyid, document_number, documentdate, duedate, status, supplier name, currency, totals (vat_exclude / vat_include) and the electronic invoicing reception data: source (pa = electronic invoice received from the Plateforme Agréée) and e_invoicing {status: received/refused/cashed, status_code: DGFiP lifecycle code} or null. Use BuyDetailTool to get the full document (items, payment terms, status dates, links). Available period values: - lastmonth, currentmonth, last3months, last6months - currentyear, lastyear, fiscalyear, lastfiscalyear - vatperiod, custom (requires date_min and date_max) Sorting: - Default sort: by document date descending (most recent first). - sort_by=e_invoicing_status orders buys without e-invoicing status first, then received, refused and cashed. Example usage: - List 10 latest buys: {"per_page": 10} - List unpaid buys: {"status": "unpaid"} - List buys of a supplier: {"supplierid": 12345} - List electronic invoices received from the Plateforme Agréée: {"source": "pa"} - List refused electronic invoices: {"e_invoicing_status": "refused"} - List expense reports only: {"document_type": "expense_report"} - Custom period: {"period": "custom", "date_min": "2026-01-01", "date_max": "2026-06-30"} Use BuyDetailTool to get the full detail of a buy, including its items.

Get detailed information about a specific buy (FR: Achat) by its ID. Returns full buy details including: - Buy identification (buyid, document_number, external_document_number) - Supplier and optional client (rebilling) info - Financial data (totals vat_exclude/vat/vat_include, paid amount, net to pay) - Status, status dates, locked state, payment terms, comment - Items with VAT breakdown, analytic info - Electronic invoicing reception data: - source: channel the document was ingested through (pa = electronic invoice received from the Plateforme Agréée) - e_invoicing.status: reception lifecycle status (received, refused, cashed) or null - e_invoicing.status_code: DGFiP lifecycle code (202, 210, 212) or null Required parameter: - buyid: The buy ID to retrieve. Use BuyListTool to find buys. Example usage: { "buyid": 12345 }

List supplier credits (FR: Avoirs fournisseurs) visible by the current user, according to visibility restrictions set in user profile. A supplier credit (FR: avoir fournisseur) is a credit note received from a supplier, reducing what the company owes. Returns a paginated list of compact summary rows: supplier_creditid, document_number, documentdate, duedate, status, supplier name, currency, totals (vat_exclude / vat_include) and the electronic invoicing reception data: source (pa = electronic document received from the Plateforme Agréée) and e_invoicing {status: received/refused/cashed, status_code: DGFiP lifecycle code} or null. Use SupplierCreditDetailTool to get the full document (items, payment terms, status dates, links). Available period values: - lastmonth, currentmonth, last3months, last6months - currentyear, lastyear, fiscalyear, lastfiscalyear - vatperiod, custom (requires date_min and date_max) Example usage: - List 10 latest supplier credits: {"per_page": 10} - List supplier credits of a supplier: {"supplierid": 12345} - List electronic documents received from the Plateforme Agréée: {"source": "pa"} - Custom period: {"period": "custom", "date_min": "2026-01-01", "date_max": "2026-06-30"} Use SupplierCreditDetailTool to get the full detail of a supplier credit, including its items.

Get detailed information about a specific supplier credit (FR: Avoir fournisseur) by its ID. Returns full supplier credit details including: - Identification (supplier_creditid, document_number, external_document_number) - Supplier info - Financial data (totals vat_exclude/vat/vat_include) - Status, status dates, locked state, payment terms, comment - Items with VAT breakdown, analytic info - Electronic invoicing reception data: - source: channel the document was ingested through (pa = electronic document received from the Plateforme Agréée) - e_invoicing.status: reception lifecycle status (received, refused, cashed) or null - e_invoicing.status_code: DGFiP lifecycle code (202, 210, 212) or null Required parameter: - supplier_creditid: The supplier credit ID to retrieve. Use SupplierCreditListTool to find supplier credits. Example usage: { "supplier_creditid": 12345 }

List the documents in the company's reception box (FR: Boîte de réception des achats, "bintray"). The reception box holds incoming purchase documents (supplier invoices, expense reports), whatever channel they arrived through: manual upload, email, scan, mobile, API, or the Plateforme Agréée (electronic invoicing). Returns the documents currently in the reception box (not paginated) — this includes documents already processed or promoted to a buy, not only pending ones; check each document's status to tell them apart. Each document comes with: - Document identification and filename - Reception date and creator - source: channel the document arrived through (pa = electronic invoice received from the Plateforme Agréée) - status (OCR/processing state) and document_type (buy or expense_report) - Electronic invoicing reception data: - e_invoicing.status: reception lifecycle status (received, refused, cashed) or null - e_invoicing.status_code: DGFiP lifecycle code (202, 210, 212) or null Example usage: - List all reception box documents: {} - List only electronic invoices received from the Plateforme Agréée: {"source": "pa"} - List refused electronic invoices: {"e_invoicing_status": "refused"} - List only the documents I uploaded myself: {"only_mine": true}

List articles (FR: Articles) in the authenticated user's company. An article (FR: article) is a product or service that can be sold to clients and added to invoices or quotes. Returns a paginated list of articles with comprehensive details including: - Article identification (ID, reference, nature, designation) - Classifications (sale and purchase) - Pricing (unit price VAT exclude/include, VAT rate, TTC flag) - Stock management (quantity, stocked quantity, weight, unit) - Margin information (purchase price, coefficient, margin %, markup %, amount) - Supplier information (supplier ID, code, name, supplier reference) - Picture link - Custom fields - Active/inactive status Optional filters: - enabled: Filter active (true) or inactive (false) articles - search: Search articles by reference, designation, etc. - nature: Filter by nature (product or service) - sale_classificationid: Filter by sale classification ID - purchase_classificationid: Filter by purchase classification ID - supplierid: Filter by supplier ID - reference: Filter articles by reference - per_page: Number of results per page (1-100, default: 15) - sort_by: Sort by field (only "articleid" allowed) - order: Sort order (asc or desc, default: asc) Example usage: - List all articles: {} - List active articles only: {"enabled": true} - Search for specific article: {"search": "Banana"} - Filter by nature: {"nature": "product"} - Get 50 articles per page: {"per_page": 50} - Sort by article ID descending: {"sort_by": "articleid", "order": "desc"}

Get detailed information about a specific article (FR: Article) by its ID. An article (FR: article) is a product or service that can be sold to clients and added to invoices or quotes. Returns comprehensive article details including: - Article identification (ID, reference, reference_clean, nature) - Designation (with and without HTML) - Classifications (sale and purchase with ID, code, label) - Pricing (unit_price_vat_exclude, unit_price_vat_include, vat rate, ttc flag) - Quantity, weight, unit - Margin information (purchase price, coefficient, margin %, markup %, amount) - Supplier info (supplierid, code, name, supplier_reference) - Stock management (stock_management flag, stocked_quantity) - Picture link - Custom fields - Enabled state Required parameter: - articleid: The article ID to retrieve. Use ArticleListTool to find articles. Picture: when the article has one, the response contains a picture_link URL pointing at the API (requires an authenticated API call to download — the image content itself is not returned by MCP tools). The API does not expose picture upload, so ArticleCreateTool and ArticleUpdateTool cannot attach one. Example usage: { "articleid": 12345 }

Create a new article (FR: Article) with given data. An article (FR: article) is a product or service that can be sold to clients and added to invoices or quotes. Required fields: - reference: Article reference - designation: Article designation Optional fields include nature, quantity, weight, unit, classifications, pricing, VAT, supplier information, stock management, etc. The API will validate all data and return the created article with its ID. Example minimal usage: { "reference": "SPLIT", "designation": "Banana Split" } Example with full details: { "reference": "SPLIT", "designation": "Banana Split <br />\nPour une durée de 12 mois", "nature": "product", "quantity": 12, "weight": 152.123, "unit": "M", "sale_classificationid": 45732, "unit_price": 36, "vat_rate": 20, "ttc": true, "purchase_unit_price_vat_exclude": 16, "purchase_classificationid": 45732, "supplierid": 9876, "supplier_reference": "SPLIT", "stock_management": true, "stocked_quantity": 5 } Notes: - unit_price is based on ttc field value (true = incl. taxes, false = excl. taxes, null = company default) - purchase_unit_price_vat_exclude must be less than unit price VAT excluded - sale_classificationid only accepted when sell classifications are enabled - HTML is accepted in designation field

Update an existing article (FR: Article) with given data. An article (FR: article) is a product or service that can be sold to clients and added to invoices or quotes. Only provided fields will be updated (partial update). Required parameters: - articleid: The article ID to update Optional fields (all nullable): - reference, nature, designation - quantity, weight, unit - sale_classificationid, purchase_classificationid - unit_price, vat_rate, ttc - purchase_unit_price_vat_exclude - supplierid, supplier_reference - stock_management, stocked_quantity - enabled (activate/deactivate article) Note: stocked_quantity only accepted when stock_management is true or article already has stock management enabled. Example minimal usage: { "articleid": 12345, "designation": "Banana Split Updated" } Example with multiple fields: { "articleid": 12345, "reference": "SPLIT-V2", "unit_price": 40, "vat_rate": 20, "stocked_quantity": 10, "enabled": true }

List invoices (FR: Factures) for the authenticated user visible according to visibility restrictions set in user profile. An invoice (FR: facture) is a commercial document issued to a client for goods or services provided. Returns a paginated list of compact summary rows: invoiceid, document_number, documentdate, duedate, status, client name, currency and totals (vat_exclude / vat_include). Use InvoiceGetTool to get the full document (items, client and contact details, payment terms, margins, links). For available status values, refer to the "invoice-statuses" resource. Available typedoc values: - invoice: Standard invoice - retention: Retention invoice (retenue de garantie) - situation: Situation/progress invoice (facture de situation) — created via QuoteProgressInvoiceTool or SaleOrderProgressInvoiceTool - benefit: Benefit invoice Available period values: - lastmonth, currentmonth, last3months, last6months - currentyear, lastyear, fiscalyear, lastfiscalyear - vatperiod, custom (requires date_min and date_max) Search by document number: Use the document_number parameter to find a specific invoice by its number (e.g., "F-20240001", "F-00000002269"). This is a strict comparison, so the full document number must be provided. Example usage: - List 10 latest invoices: {"per_page": 10} - List sent invoices: {"status": "sent"} - List unpaid invoices: {"status": "unpaid"} - List invoices for a client: {"clientid": 12345} - Find invoice by document number: {"document_number": "F-20240001"} - List invoices for a custom period: {"period": "custom", "date_min": "2024-01-01", "date_max": "2024-12-31"} - Sort by invoice ID descending: {"sort_by": "invoiceid", "order": "desc"} Default sort: by document_date and document_number descending (most recent first).

Get detailed information about a specific invoice (FR: Facture) by its ID. An invoice (FR: facture) is a commercial document issued to a client, detailing the products/services sold and the payment terms. Returns comprehensive invoice details including: - Invoice identification (invoiceid, document_number, external_document_number, typedoc) - Status (filled, create, sent, inpayment, paid, match, nopaid, unpaid, locked) - enabled: false when the document has been cancelled (FR: annulé — e.g. an invoice cancelled by a credit). Its status keeps its last value (create, sent…): always present such a document as « Annulé » first; its PDF is no longer available - Dates (documentdate, duedate, execdate) - Client info (clientid, client object with code, name, civility, address, postcode, town, country, iso) - Contact info (contactid, contact object with civility, lastname, firstname, email, phone) - Delivery address (delivery_address object with label, address, postcode, town, country, iso) - Object and comment fields - Items array with full details: - type (article, sub_total, text) - itemid, articleid, reference, designation - quantity, unit, unit_price, vat_rate - rebate, total_vat_exclude, total_vat_include - margin info (purchase_unit_price, margin, margin_rate, markup) - sale_classificationid - Financial totals: - total_vat_exclude, total_vat_include - total_rebate, global_rebate - remaining_vat_exclude, remaining_vat_include - paid_vat_exclude, paid_vat_include - VAT summary (vat_sums array with rate, base_vat_exclude, total_vat) - Margin totals (total_margin, total_margin_rate, total_markup) - Payment terms (term object with paytype, payterm, duedate, penalty, recovery_indemnity, paydelay, endmonth, payday) - Retention info (retention object with percent, total, date) - Bonuses array (post-tax deductions with label and amount) - Progress info (for situation invoices: progress.overall and progress.current percentages) - Currency, analyticid, templateid - Labels array, lockdate - Created/updated timestamps Not returned: whether the document includes the sale general conditions (FR: CGV). The API does not expose this information, so never state that a document does or does not include its CGV. When copying or duplicating a document, ask the user whether the CGV must be included (include_sale_general_conditions on the Create tools). Tip: Use show_items_extended=true to include items of type text and sub_total in the response. By default, only article items are returned. Required parameter: - invoiceid: The invoice ID to retrieve. Use InvoiceListTool to find invoices. To get the PDF file: Share the "webdoc" URL returned in the response: it is a public page where the user can view and download the document PDF. Never invent a webdoc URL; if it is absent, say the document has no shareable link yet. Example usage: { "invoiceid": 12345 }

Create a new draft invoice (FR: Facture) with given data. The created invoice will have status "filled" (draft). An invoice (FR: facture) is a commercial document issued to a client for goods or services provided. Totals, margins, retention, and included VAT fields are automatically calculated. Required fields: - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID to attach the invoice to Optional fields include client contact, delivery address, payment terms, items, retention, bonuses, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog) OR reference+designation for a free item. - sub_total: Subtotal line. Only designation is used. - text: Text-only line. Only designation is used. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) Bonuses (post-tax deductions): - Maximum 3 per document, total cannot exceed the net amount to pay - Requires the bonuses feature to be enabled in company settings Note: This tool creates standard invoices. For progress invoices (factures de situation), use QuoteProgressInvoiceTool or SaleOrderProgressInvoiceTool instead. The API will validate all data and return the created invoice with its ID. Example minimal usage: { "documentdate": "2024-01-15", "clientid": 12345 } Example with items: { "documentdate": "2024-01-15", "clientid": 12345, "object": "Abonnement Logiciel", "items": [ { "type": "article", "reference": "SOFT-001", "designation": "Licence annuelle", "quantity": 1, "unit": "U", "unit_price": 1200.00, "vat_rate": 20 } ] }

Save a draft invoice (FR: Facture) with a definitive document number. An invoice (FR: facture) is a commercial document issued to a client for goods or services provided. This tool transforms a draft invoice (status "filled") into a created invoice (status "created") with a permanent document number. Prerequisite: The invoice must be in "filled" status (draft). Use InvoiceListTool with status="filled" to find drafts. IMPORTANT: This action is irreversible. Once saved, the invoice cannot be reverted to draft status. The document number becomes permanent and sequential. You MUST ask the user for explicit confirmation before calling this tool. Never call it automatically after creating a draft. Required parameters: - invoiceid: The draft invoice ID to save Optional parameters: - auto_recovery_enabled: Enable auto recovery (if not specified, uses default company setting) Workflow: 1. Create draft invoice (InvoiceCreateTool) → status: "filled" 2. Save invoice (this tool) → status: "created" with definitive document number After saving: - The invoice receives a definitive document number (e.g., "F-20190000160") - Status changes from "filled" to "created" - The invoice becomes locked and can no longer be edited freely Example usage: - Save draft invoice: {"invoiceid": 2476128} - Save with auto recovery: {"invoiceid": 2476128, "auto_recovery_enabled": true}

Update an existing invoice (FR: Facture) with given data. IMPORTANT: This is a PUT request (full replacement). Fields not provided will be reset to defaults. Always retrieve current data with InvoiceGetTool first, modify what you need, then send the complete object back. WARNING: This endpoint CANNOT be used for progress invoices (typedoc "situation"). To update a progress invoice, use InvoiceProgressUpdateTool instead. An invoice (FR: facture) is a commercial document issued to a client for goods or services provided. Totals, margins, retention, and included VAT fields are automatically calculated. Required fields: - invoiceid: The invoice ID to update - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID to attach the invoice to Optional fields include client contact, delivery address, payment terms, items, retention, bonuses, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog) OR reference+designation for a free item. - sub_total: Subtotal line. Only designation is used. - text: Text-only line. Only designation is used. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) Bonuses (post-tax deductions): - Maximum 3 per document, total cannot exceed the net amount to pay - Requires the bonuses feature to be enabled in company settings The API will validate all data and return the updated invoice. Example minimal usage: { "invoiceid": 2476128, "documentdate": "2024-01-15", "clientid": 12345 } Example with items: { "invoiceid": 2476128, "documentdate": "2024-01-15", "clientid": 12345, "object": "Abonnement Logiciel", "items": [ { "type": "article", "reference": "SOFT-001", "designation": "Licence annuelle", "quantity": 1, "unit": "U", "unit_price": 1200.00, "vat_rate": 20 } ] }

Send an invoice (FR: Facture) by email with a link to the invoice. An invoice (FR: facture) is a commercial document issued to a client for goods or services provided. Prerequisite: The invoice must be in "created" status or later (not "filled" draft). Use InvoiceSaveTool first to save a draft. After sending, the invoice status changes to "sent". This tool sends an email notification to one or more recipients with a link to view the invoice. You can optionally attach the PDF document and customize the email content. The subject and body fields support dynamic variables that are automatically replaced: Use EmailDynamicFieldsResource to see available dynamic fields (e.g., {DOCUMENT_NUMBER}, {CLIENT_NAME}, etc.). Required parameters: - invoiceid: The invoice ID to send - to: Array of recipient email addresses Optional parameters: - from: Sender's email (defaults to configured SMTP or notification@evoliz.com) - copy: Send a copy to your user email address (boolean) - attachment: Add the PDF document as an attachment (boolean) - subject: Custom email subject (string, supports dynamic fields) - body: Custom email body in text or HTML (string, supports dynamic fields) - signature: Include company signature in the email (boolean, default: true) - links: Add "View PDF" and "Download PDF" links (boolean, deprecated) - contact: Contact information object with civility, lastname, firstname Note: In demo mode, you can only send emails to the authenticated company's email address. Example minimal usage: { "invoiceid": 2476128, "to": ["client@example.com"] } Example with full options: { "invoiceid": 2476128, "to": ["client@example.com", "accounting@example.com"], "from": "sales@mycompany.com", "copy": true, "attachment": true, "subject": "Your invoice from ACME Corp", "body": "Please find your invoice attached.", "signature": true, "contact": { "civility": "Monsieur", "lastname": "Dupont", "firstname": "Jean" } }

List all payments (FR: Règlements) for a specific invoice. A payment (FR: règlement) is a financial transaction recording money received from a client for an invoice. Required parameter: - invoiceid: The invoice ID to list payments for. Use InvoiceListTool to find invoices. Optional parameters: - per_page: Number of results per page (1-100, default 15) - page: Page number for pagination (default 1) Returns paginated list of payments with details including: - Payment identification (paymentid, external_id) - Dates (paydate) - Amount (amount, currency) - Label and comment - Payment method (paytypeid, paytype object with code and label) - Client info (clientid, client object with code, name) - Invoice info (invoiceid, document_number) - Cash entry reference (cashentryid, cash_entry object) - Credit note info if applicable (creditid, paytypeid=13 indicates credit note payment) - Created/updated timestamps Use page and per_page parameters to navigate through paginated results when multiple pages exist. Example usage: { "invoiceid": 4013943 } Example with pagination: { "invoiceid": 4013943, "per_page": 50, "page": 2 }

Create a new payment (FR: Règlement) on an invoice. A payment (FR: règlement) records money received from a client for an invoice. IMPORTANT: Before creating a payment, you MUST ask the user which payment method they want to use. Refer to the "payment-methods" resource for the full list of available methods and present them to the user. Required fields: - invoiceid: The invoice ID to add the payment to - paydate: Payment date (YYYY-MM-DD format) - label: Payment label/description - paytypeid: Payment method ID (ask the user to choose from the payment-methods resource) IMPORTANT - Two payment modes: 1. Standard payment (any paytypeid except 13): - amount: REQUIRED (cannot exceed invoice remaining balance: remaining_vat_include) - creditid: PROHIBITED 2. Credit note payment (paytypeid = 13): - creditid: REQUIRED (credit note ID to use) - amount: PROHIBITED (calculated automatically from credit note) - The credit note must not be already used and must belong to the same company Optional fields: - comment: Comments on the payment

Update a draft progress invoice (FR: Facture de situation). This endpoint is specifically for progress invoices (typedoc "situation"). Do NOT use InvoiceUpdateTool for progress invoices. The invoice must be in draft status ("filled"). Editable fields: - documentdate, object, comment, execdate - include_sale_general_conditions, global_rebate - Progress (global or per-item) - retention (date and percent) - bonus_ids (bonus selection from source document) Progression modes: 1. Global progression: - Set progress.overall (cumulative %) or progress.current (this invoice's %) - Applies to all items linked to the source document 2. Detailed progression (per item): - Provide items with itemid and progress (overall or current) or quantity - Items linked to the source document can ONLY have their progression modified - Their designation, price, etc. cannot be changed here Retention: - Omit retention field to preserve existing values - Set retention to null to reset retention fields - retention.percent can only be updated if not already defined in the source document Bonus management (bonus_ids): - Omit bonus_ids entirely: existing bonuses are preserved - Empty array []: all bonuses are removed - Array with IDs [1, 2]: replaces existing bonuses with specified ones - Each bonus can only be applied to one progress invoice at a time - Do NOT send bonus_ids: null — omit the field entirely to preserve Required parameter: - invoiceid: The progress invoice ID to update Example — update global progression: { "invoiceid": 12345, "progress": {"overall": 75} } Example — update detailed progression: { "invoiceid": 12345, "items": [ {"itemid": 100, "progress": {"overall": 90}}, {"itemid": 101, "progress": {"current": 20}} ] } Example — update metadata and bonuses: { "invoiceid": 12345, "documentdate": "2024-06-15", "object": "Facture de situation n°2 - Chantier Dupont", "progress": {"current": 30}, "bonus_ids": [1, 2] }

Add new items to a draft progress invoice (FR: Facture de situation). This tool allows adding NEW items to an existing progress invoice. These are free items not linked to the original quote/sale order. The invoice must be in draft status ("filled") and of type SITUATION. Item types: - article: Product/service line with reference, designation, quantity, unit_price, vat_rate - sub_total: Subtotal separator line. Only designation is used. - text: Free text line. Only designation is used. The invoice totals are automatically recalculated after adding items. Required parameters: - invoiceid: The progress invoice ID - items: Array of items to add (at least one) Example — add article items: { "invoiceid": 12345, "items": [ { "type": "article", "reference": "SERVICE01", "designation": "Service supplémentaire", "quantity": 1, "unit": "U", "unit_price": 500.00, "vat_rate": 20 } ] } Example — add mixed items: { "invoiceid": 12345, "items": [ { "type": "article", "reference": "ITEM001", "designation": "Item ajouté", "quantity": 5, "unit": "U", "unit_price": 150.00, "vat_rate": 20 }, { "type": "text", "designation": "Note: Service effectué le 15/12/2024" }, { "type": "sub_total", "designation": "Sous-total services" } ] }

Delete an item from a draft progress invoice (FR: Facture de situation). This tool removes an item from an existing progress invoice. The invoice must be in draft status ("filled") and of type SITUATION. Restrictions: - Cannot delete the last article item from an invoice - Cannot delete items with progress (items linked to the original quote/sale order) - Only items that were freely added to the progress invoice (not from the source document) can be deleted - The invoice totals are automatically recalculated after deletion Use InvoiceGetTool with show_items_extended=true to see all items and their IDs before deleting. Required parameters: - invoiceid: The progress invoice ID - itemid: The item ID to delete Example usage: { "invoiceid": 12345, "itemid": 67890 }

Create a total credit note (FR: avoir total) from an existing invoice. A total credit note cancels the entire invoice amount. The credit is automatically finalized (receives a definitive document number) upon creation. IMPORTANT CONSTRAINTS: - The invoice must NOT have any payments recorded. If the invoice has payments, they must be deleted first. - If the credit amount equals the invoice amount, the invoice will be marked as deleted. - This action creates a finalized credit note (not a draft). Required parameters: - invoiceid: The invoice ID to create a total credit from. Use InvoiceListTool to find invoices. Optional parameters: - documentdate: Document date for the credit (YYYY-MM-DD). Defaults to today's date. Must be between today and +30 days. The created credit note will: - Mirror all items from the original invoice - Have the same client, contact, and delivery address - Be automatically saved with a definitive document number - Reference the original invoice E-invoicing note: the created credit copies its business process (FR: type d'opération) from the source invoice. When the company has enabled electronic invoicing (FR: facturation électronique), the invoice must carry one, otherwise the operation is rejected (400). Example usage: - Create total credit from invoice: {"invoiceid": 2476128} - Create total credit with specific date: {"invoiceid": 2476128, "documentdate": "2024-02-01"}

Create a partial credit note (FR: avoir partiel) from an existing invoice. A partial credit note cancels part of an invoice amount. Unlike the total credit (InvoiceCreditTool), this creates a DRAFT credit note (status "filled") that must be saved separately using CreditSaveTool. IMPORTANT CONSTRAINTS: - Cannot be used on invoices that have bonuses (post-tax deductions). - Items and term are required to define the partial credit content. - The created credit will be in draft status and needs to be saved (CreditSaveTool) to get a document number. Required parameters: - invoiceid: The invoice ID to create a partial credit from - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID - term: Payment terms object - items: Array of items to include in the partial credit Optional parameters include contact, delivery address, comment, retention, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog) OR reference+designation for a free item. - sub_total: Subtotal line. Only designation is used. - text: Text-only line. Only designation is used. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) Workflow: 1. Create partial credit from invoice (this tool) -> status: "filled" (draft) 2. Save the credit (CreditSaveTool) -> status: "created" with definitive document number 3. Optionally send the credit (CreditSendTool) Example usage: { "invoiceid": 2476128, "documentdate": "2024-02-01", "clientid": 12345, "term": { "paytermid": 1, "paytypeid": 1 }, "items": [ { "type": "article", "designation": "Partial refund - Licence annuelle", "quantity": 1, "unit": "U", "unit_price": 600.00, "vat_rate": 20 } ] }

List bonus payments (FR: Paiements de primes/escomptes) for a specific invoice. Bonus payments are discount-related payments applied to an invoice when the bonuses/primes feature is enabled. Returns paginated list of bonus payments with standard payment details including: - Payment identification (paymentid) - Payment info (paydate, label, amount, paytype) - Client information Required parameter: - invoiceid: The invoice ID to list bonus payments for. Example usage: {"invoiceid": 12345}

Create a bonus payment (FR: Paiement de prime/escompte) for an invoice. Bonus payments are discount-related payments applied to an invoice. The bonuses/primes feature must be enabled for the company. Required parameters: - invoiceid: The invoice ID to create the bonus payment for - paydate: Payment date (YYYY-MM-DD format) - paytypeid: Payment type ID (use PayTypeListTool to find types, type 13 is not allowed) - amount: Payment amount (must not exceed remaining bonus amount to pay) Optional parameters: - label: Payment label (max 80 characters) - comment: Payment comment Example usage: { "invoiceid": 12345, "paydate": "2025-06-15", "paytypeid": 1, "amount": 50.00, "label": "Bonus payment Q2" }

List credits (FR: Avoirs) for the authenticated user visible according to visibility restrictions set in user profile. A credit note (FR: avoir) is a document that cancels all or part of an invoice. Returns a paginated list of compact summary rows: creditid, document_number, documentdate, duedate, status, client name, currency and totals (vat_exclude / vat_include). Use CreditDetailTool to get the full document (items, client and contact details, payment terms, links). For available status values, refer to the "credit-statuses" resource. Available period values: - lastmonth, currentmonth, last3months, last6months - currentyear, lastyear, fiscalyear, lastfiscalyear - vatperiod, custom (requires date_min and date_max) Search by document number: Use the document_number parameter to find a specific credit by its number (e.g., "AV-20240001"). This is a strict comparison, so the full document number must be provided. Example usage: - List 10 latest credits: {"per_page": 10} - List sent credits: {"status": "sent"} - List credits for a client: {"clientid": 12345} - Find credit by document number: {"document_number": "AV-20240001"} - List credits for a custom period: {"period": "custom", "date_min": "2024-01-01", "date_max": "2024-12-31"} - Sort by credit ID descending: {"sort_by": "creditid", "order": "desc"} Default sort: by document_date and document_number descending (most recent first).

Get detailed information about a specific credit (FR: Avoir) by its ID. A credit note (FR: avoir) is a document that cancels all or part of an invoice. Returns comprehensive credit details including: - Credit identification (creditid, document_number, external_document_number) - Status (filled, create, sent, inpayment, paid, match, nopaid, unpaid, locked) - enabled: false when the document has been cancelled (FR: annulé — e.g. an invoice cancelled by a credit). Its status keeps its last value (create, sent…): always present such a document as « Annulé » first; its PDF is no longer available - Dates (documentdate, duedate, execdate) - Client info (clientid, client object with code, name, civility, address, postcode, town, country, iso) - Contact info (contactid, contact object with civility, lastname, firstname, email, phone) - Delivery address (delivery_address object with label, address, postcode, town, country, iso) - Object and comment fields - Items array with full details: - type (article, sub_total, text) - itemid, articleid, reference, designation - quantity, unit, unit_price, vat_rate - rebate, total_vat_exclude, total_vat_include - sale_classificationid - Financial totals: - total_vat_exclude, total_vat_include - total_rebate, global_rebate - remaining_vat_exclude, remaining_vat_include - paid_vat_exclude, paid_vat_include - VAT summary (vat_sums array with rate, base_vat_exclude, total_vat) - Payment terms (term object with paytype, payterm, duedate, penalty, recovery_indemnity, paydelay, endmonth, payday) - Retention info (retention object with percent, total, date) - Bonuses array (post-tax deductions with label and amount) - Currency, analyticid, templateid - Labels array, lockdate - Created/updated timestamps Not returned: whether the document includes the sale general conditions (FR: CGV). The API does not expose this information, so never state that a document does or does not include its CGV. When copying or duplicating a document, ask the user whether the CGV must be included (include_sale_general_conditions on the Create tools). Tip: Use show_items_extended=true to include items of type text and sub_total in the response. By default, only article items are returned. Required parameter: - creditid: The credit ID to retrieve. Use CreditListTool to find credits. To get the PDF file: Share the "webdoc" URL returned in the response: it is a public page where the user can view and download the document PDF. Never invent a webdoc URL; if it is absent, say the document has no shareable link yet. Example usage: { "creditid": 12345 }

Create a new draft credit note (FR: Avoir) with given data. The created credit will have status "filled" (draft). A credit note (FR: avoir) is a document that cancels all or part of an invoice. Totals, retention, and included VAT fields are automatically calculated. Required fields: - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID to attach the credit to Optional fields include client contact, delivery address, payment terms, items, retention, bonuses, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog) OR reference+designation for a free item. - sub_total: Subtotal line. Only designation is used. - text: Text-only line. Only designation is used. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) Bonuses (post-tax deductions): - Maximum 3 per document, total cannot exceed the net amount to pay - Requires the bonuses feature to be enabled in company settings Retention: - percent: Retention percentage - date: Retention date (YYYY-MM-DD) The API will validate all data and return the created credit with its ID. Example minimal usage: { "documentdate": "2024-01-15", "clientid": 12345 } Example with items: { "documentdate": "2024-01-15", "clientid": 12345, "object": "Avoir sur facture F-20240001", "items": [ { "type": "article", "reference": "SOFT-001", "designation": "Licence annuelle", "quantity": 1, "unit": "U", "unit_price": 1200.00, "vat_rate": 20 } ] }

Update an existing credit note (FR: Avoir) with given data. IMPORTANT: This is a PUT request (full replacement). Fields not provided will be reset to defaults. Always retrieve current data with CreditDetailTool first, modify what you need, then send the complete object back. A credit note (FR: avoir) is a document that cancels all or part of an invoice. Totals, retention, and included VAT fields are automatically calculated. Required fields: - creditid: The credit ID to update - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID to attach the credit to Optional fields include client contact, delivery address, payment terms, items, retention, bonuses, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog) OR reference+designation for a free item. - sub_total: Subtotal line. Only designation is used. - text: Text-only line. Only designation is used. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) Bonuses (post-tax deductions): - Maximum 3 per document, total cannot exceed the net amount to pay - Requires the bonuses feature to be enabled in company settings The API will validate all data and return the updated credit. Example minimal usage: { "creditid": 2476128, "documentdate": "2024-01-15", "clientid": 12345 } Example with items: { "creditid": 2476128, "documentdate": "2024-01-15", "clientid": 12345, "object": "Avoir sur facture F-20240001", "items": [ { "type": "article", "reference": "SOFT-001", "designation": "Licence annuelle", "quantity": 1, "unit": "U", "unit_price": 1200.00, "vat_rate": 20 } ] }

Save a draft credit note (FR: Avoir) with a definitive document number. A credit note (FR: avoir) is a document that cancels all or part of an invoice. This tool transforms a draft credit (status "filled") into a created credit (status "created") with a permanent document number. Prerequisite: The credit must be in "filled" status (draft). Use CreditListTool with status="filled" to find drafts. IMPORTANT: This action is irreversible. Once saved, the credit cannot be reverted to draft status. The document number becomes permanent and sequential. You MUST ask the user for explicit confirmation before calling this tool. Never call it automatically after creating a draft. Required parameters: - creditid: The draft credit ID to save Workflow: 1. Create draft credit (CreditCreateTool) -> status: "filled" 2. Save credit (this tool) -> status: "created" with definitive document number After saving: - The credit receives a definitive document number (e.g., "AV-20190000160") - Status changes from "filled" to "created" - The credit becomes locked and can no longer be edited freely Example usage: - Save draft credit: {"creditid": 2476128}

Send a credit note (FR: Avoir) by email with a link to the credit. A credit note (FR: avoir) is a document that cancels all or part of an invoice. Prerequisite: The credit must be in "created" status or later (not "filled" draft). Use CreditSaveTool first to save a draft. After sending, the credit status changes to "sent". This tool sends an email notification to one or more recipients with a link to view the credit. You can optionally attach the PDF document and customize the email content. The subject and body fields support dynamic variables that are automatically replaced: Use EmailDynamicFieldsResource to see available dynamic fields (e.g., {DOCUMENT_NUMBER}, {CLIENT_NAME}, etc.). Required parameters: - creditid: The credit ID to send - to: Array of recipient email addresses Optional parameters: - from: Sender's email (defaults to configured SMTP or notification@evoliz.com) - copy: Send a copy to your user email address (boolean) - attachment: Add the PDF document as an attachment (boolean) - subject: Custom email subject (string, supports dynamic fields) - body: Custom email body in text or HTML (string, supports dynamic fields) - signature: Include company signature in the email (boolean, default: true) - links: Add "View PDF" and "Download PDF" links (boolean, deprecated) - contact: Contact information object with civility, lastname, firstname Note: In demo mode, you can only send emails to the authenticated company's email address. Example minimal usage: { "creditid": 2476128, "to": ["client@example.com"] } Example with full options: { "creditid": 2476128, "to": ["client@example.com", "accounting@example.com"], "from": "sales@mycompany.com", "copy": true, "attachment": true, "subject": "Your credit note from ACME Corp", "body": "Please find your credit note attached.", "signature": true, "contact": { "civility": "Monsieur", "lastname": "Dupont", "firstname": "Jean" } }

List deliveries (FR: Bons de livraison) for the authenticated user visible according to visibility restrictions set in user profile. A delivery note (FR: bon de livraison) is a document accompanying goods shipped to a client, confirming the items and quantities delivered. Can be converted into an invoice. Returns a paginated list of compact summary rows: deliveryid, document_number, documentdate, duedate, status, client name, currency and totals (vat_exclude / vat_include). Use DeliveryDetailTool to get the full document (items, client and contact details, shipping info, links). For available status values, refer to the "delivery-statuses" resource. Available period values: - lastmonth, currentmonth, last3months, last6months - currentyear, lastyear, fiscalyear, lastfiscalyear - vatperiod, custom (requires date_min and date_max) Example usage: - List 10 latest deliveries: {"per_page": 10} - List sent deliveries: {"status": "sent"} - List deliveries for a client: {"clientid": 12345} - List deliveries for a custom period: {"period": "custom", "date_min": "2024-01-01", "date_max": "2024-12-31"} - Sort by delivery ID descending: {"sort_by": "deliveryid", "order": "desc"} Default sort: by document_date and document_number descending (most recent first).

Get detailed information about a specific delivery note (FR: Bon de livraison) by its ID. A delivery note (FR: bon de livraison) is a document accompanying goods shipped to a client, confirming the items and quantities delivered. Returns comprehensive delivery details including: - Delivery identification (deliveryid, document_number, external_document_number) - Status (filled, create, sent, reject, accept, wait, invoice, close, noinvoice) - enabled: false when the document has been cancelled (FR: annulé — e.g. an invoice cancelled by a credit). Its status keeps its last value (create, sent…): always present such a document as « Annulé » first; its PDF is no longer available - Dates (documentdate) - Client info (clientid, client object with code, name, civility, address, postcode, town, country, iso) - Contact info (contactid, contact object with civility, lastname, firstname, email, phone) - Delivery address (delivery_address object with label, address, postcode, town, country, iso) - Object and comment fields - Delivery-specific fields: - number_packages: Number of packages in the delivery - package_weight: Total weight of packages - total_quantity: Total quantity of items delivered - shipping_info: Shipping/tracking information - Items array with full details: - type (article, text) - itemid, articleid, reference, designation - quantity, unit, unit_price - weight: Item weight (delivery-specific field) - Financial totals: - total_vat_exclude, total_vat_include - Payment terms (term object with paytype, payterm) - Currency, analyticid, templateid - Labels array - Created/updated timestamps Not returned: whether the document includes the sale general conditions (FR: CGV). The API does not expose this information, so never state that a document does or does not include its CGV. When copying or duplicating a document, ask the user whether the CGV must be included (include_sale_general_conditions on the Create tools). Tip: Use show_items_extended=true to include items of type text in the response. By default, only article items are returned. Required parameter: - deliveryid: The delivery ID to retrieve. Use DeliveryListTool to find deliveries. To get the PDF file: Share the "webdoc" URL returned in the response: it is a public page where the user can view and download the document PDF. Never invent a webdoc URL; if it is absent, say the document has no shareable link yet. Example usage: { "deliveryid": 12345 }

Create a new delivery note (FR: Bon de livraison) with given data. A delivery note (FR: bon de livraison) is a document accompanying goods shipped to a client, confirming the items and quantities delivered. CRITICAL: Unlike invoices, creating a delivery note is NOT a draft operation. The delivery is immediately saved with its permanent, irreversible document number (status "create", FR: « Enregistré »). There is no draft stage and no separate save step for deliveries. NEVER call this tool without the user's explicit confirmation of the delivery content. Totals are automatically calculated. IMPORTANT: Delivery items do NOT have vat_rate, rebate, or sale_classificationid fields. The only delivery-specific field on items is "weight" (item weight). There are NO sub_total items for deliveries. Required fields: - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID to attach the delivery to - term: Payment terms (term.paytermid is required) - items: At least one document line Optional fields include client contact, delivery address, shipping info, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog, requires articleid+quantity) OR type+designation+quantity+unit_price for a free item. - text: Text-only line. Only type and designation are used. Note: There are NO sub_total items for deliveries. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) The API will validate all data and return the created delivery with its ID. Example minimal usage: { "documentdate": "2024-01-15", "clientid": 12345, "term": {"paytermid": 1}, "items": [ { "type": "article", "designation": "Carton de pièces détachées", "quantity": 1, "unit_price": 50.00 } ] } Example with more options: { "documentdate": "2024-01-15", "clientid": 12345, "object": "Livraison Matériel", "number_packages": 3, "shipping_info": "Transporteur: DHL - Tracking: 1234567890", "items": [ { "type": "article", "reference": "MAT-001", "designation": "Carton de pièces détachées", "quantity": 10, "unit": "U", "unit_price": 50.00, "weight": 2.5 } ] }

Update an existing delivery note (FR: Bon de livraison) with given data. IMPORTANT: This is a PUT request (full replacement). Fields not provided will be reset to defaults. Always retrieve current data with DeliveryDetailTool first, modify what you need, then send the complete object back. A delivery note (FR: bon de livraison) is a document accompanying goods shipped to a client, confirming the items and quantities delivered. Totals are automatically calculated. IMPORTANT: Delivery items do NOT have vat_rate, rebate, or sale_classificationid fields. The only delivery-specific field on items is "weight" (item weight). There are NO sub_total items for deliveries. Required fields: - deliveryid: The delivery ID to update - documentdate: Document date (YYYY-MM-DD format) - clientid: The client's ID to attach the delivery to Optional fields include client contact, delivery address, payment terms, items, shipping info, etc. Item types: - article: Product/service line. Can use articleid (pre-filled from catalog, requires articleid+quantity) OR type+designation+quantity+unit_price for a free item. - text: Text-only line. Only type and designation are used. Note: There are NO sub_total items for deliveries. Payment terms (term) - conditional fields: - paytermid=16 (Custom condition): paydelay, endmonth, payday are required - paytermid=18 (Enter a date): duedate is required (must be >= documentdate) The API will validate all data and return the updated delivery. Example minimal usage: { "deliveryid": 2476128, "documentdate": "2024-01-15", "clientid": 12345 } Example with items: { "deliveryid": 2476128, "documentdate": "2024-01-15", "clientid": 12345, "object": "Livraison Matériel", "number_packages": 3, "shipping_info": "Transporteur: DHL - Tracking: 1234567890", "items": [ { "type": "article", "reference": "MAT-001", "designation": "Carton de pièces détachées", "quantity": 10, "unit": "U", "unit_price": 50.00, "weight": 2.5 } ] }

Send a delivery note (FR: Bon de livraison) by email with a link to the delivery document. A delivery note (FR: bon de livraison) is a document accompanying goods shipped to a client, confirming the items and quantities delivered. Prerequisite: The delivery must be in "create" status or later (not a "filled" draft). Deliveries created through the API (DeliveryCreateTool) are numbered and saved immediately, so they can be sent right away. A draft created in the evoliz web app must be saved there first — no MCP tool can save it. After sending, the delivery status changes to "sent". This tool sends an email notification to one or more recipients with a link to view the delivery note. You can optionally attach the PDF document and customize the email content. The subject and body fields support dynamic variables that are automatically replaced: Use EmailDynamicFieldsResource to see available dynamic fields (e.g., {DOCUMENT_NUMBER}, {CLIENT_NAME}, etc.). Additional delivery-specific dynamic fields: - {TOTALQTY}: Total quantity of items in the delivery - {WEIGHTPACK}: Total weight of packages - {QTYPACK}: Number of packages Required parameters: - deliveryid: The delivery ID to send - to: Array of recipient email addresses Optional parameters: - from: Sender's email (defaults to configured SMTP or notification@evoliz.com) - copy: Send a copy to your user email address (boolean) - attachment: Add the PDF document as an attachment (boolean) - subject: Custom email subject (string, supports dynamic fields) - body: Custom email body in text or HTML (string, supports dynamic fields) - signature: Include company signature in the email (boolean, default: true) - links: Add "View PDF" and "Download PDF" links (boolean, deprecated) - contact: Contact information object with civility, lastname, firstname Note: In demo mode, you can only send emails to the authenticated company's email address. Example minimal usage: { "deliveryid": 2476128, "to": ["client@example.com"] } Example with full options: { "deliveryid": 2476128, "to": ["client@example.com", "warehouse@example.com"], "from": "logistics@mycompany.com", "copy": true, "attachment": true, "subject": "Your delivery note from ACME Corp", "body": "Please find your delivery note attached. Packages: {QTYPACK}, Total weight: {WEIGHTPACK}kg.", "signature": true, "contact": { "civility": "Monsieur", "lastname": "Dupont", "firstname": "Jean" } }

Convert a delivery note (FR: Bon de livraison) into an invoice (FR: Facture). This tool creates a new invoice from the delivery data automatically, copying all the delivery data (client, items, terms, etc.) to a new invoice document. No request body is needed. Prerequisite: The delivery must be in a valid status for conversion (typically "created" or later, not "filled" draft). The created invoice inherits all data from the delivery: - Client/contact information - Items, quantities, prices - Payment terms - Comments, delivery address, etc. The created invoice will be in "filled" (draft) status. Use InvoiceSaveTool to finalize it with a definitive document number. E-invoicing note: the created invoice copies its business process (FR: type d'opération) from the source delivery. When the company has enabled electronic invoicing (FR: facturation électronique), the delivery must carry one, otherwise the conversion is rejected (400). There is no parameter for it here — set business_process on the delivery itself. Required parameter: - deliveryid: The delivery ID to convert into an invoice Example usage: { "deliveryid": 2476128 }

List quotes (FR: Devis) visible by the current user according to visibility restrictions. A quote (FR: devis) is a commercial proposal sent to a client or prospect before an invoice is issued. Returns a paginated list of compact summary rows: quoteid, document_number, documentdate, duedate, status, client name, currency and totals (vat_exclude / vat_include). Use QuoteDetailTool to get the full document (items, client and contact details, payment terms, margins, links). Optional filters (extensive filtering available): - per_page: Pagination (1-100, default: 15) - userid, clientid, prospectid: Filter by creator/client/prospect - organization: Filter by type (CLIENT or PROSPECT) - currency: ISO currency code (e.g., EUR) - status: Quote status filter (refer to the "quote-statuses" resource for the full list) - paytypeid, analyticid: Payment type and analytic axis - amount_min/amount_max: Amount range (with amount_type) - enabled: Active/inactive quotes - search: Search parameter - period: Time period (lastmonth, currentmonth, custom, etc.) - date_min/date_max: Custom date range (requires period=custom) - sort_by, order: Sorting options - document_number: Filter by exact document number - show_items_extended: Include text and sub_total items (default: false) Search by document number: Use the document_number parameter to find a specific quote by its number (e.g., "D-20240001", "D-00000002269"). This is a strict comparison, so the full document number must be provided. Example usage: - List all quotes: {} - Filter by client: {"clientid": 9876} - Filter by status: {"status": "sent"} - Find quote by document number: {"document_number": "D-20240001"} - Custom date range: {"period": "custom", "date_min": "2024-01-01", "date_max": "2024-12-31"} - Amount range: {"amount_min": 100, "amount_max": 1000, "amount_type": "vat_exclude"} Note: clientid and prospectid are mutually exclusive. Do not use both at the same time. The response may include bonuses (post-tax deductions) and retention info when applicable. Default sort: by document_date and document_number descending (most recent first).