> ## Documentation Index > Fetch the complete documentation index at: https://docs.filexpress.app/llms.txt > Use this file to discover all available pages before exploring further. # External Integrations > Connect third-party systems to FileXpress through the API Integrations let other systems (POS, ERP, online stores, biometric clocks, payroll or BI systems) connect to your business in FileXpress through the External API. Each integration has its own API Key and only accesses the permissions you assign to it. > [!TIP] > > The complete technical reference (endpoints, fields, and examples) is in the **[External API](https://docs.filexpress.app/en/docs/api/introduccion.md)** tab. Share it with the technical team that will build the integration. > [!NOTE] > > The **external API v2** adds currencies and exchange rates and country capabilities: sales and purchases with `currency_code` and `exchange_rate`, currency and rate queries, queries of a country's billing catalogs and capabilities, taxes by id, and errors with a stable code. Version 1 keeps working the same way. To use the new endpoints, the integration needs the **Currencies and exchange rates** (`currencies`) and **Country capabilities and catalogs** (`countries`) permissions. See [Multi-currency](https://docs.filexpress.app/en/docs/sistema/multi-moneda.md). ## The Integrations view In **Integrations** you see the list of the business's integrations. ### Summary At the top there are four cards: | Card | What it shows | | - | - | | **Integrations** | Total integrations of the business. | | **Active** | How many are active. | | **Inactive** | How many are suspended. | | **Last activity** | Date and time of the most recent use of any of them, or "No activity" if none has been used. | ### Search and filter * The search box filters by **name** or by **API Key**; it is case- and accent-insensitive. * The status filter has three options: **All**, **Active**, and **Inactive**. * If no integration matches, the view says so; if there are no integrations yet, it offers the **New integration** button. ### Each integration's card Each integration is shown as a card with: * **Name and status** (Active or Inactive). The switch in the corner turns the integration on or off without deleting it: an inactive integration rejects all requests from its API Key. * **Masked API Key** (only the first and last characters are visible). The eye icon shows or hides it and the copy icon sends it to the clipboard. * **Assigned permissions**: up to three tags and a "+N more" with the rest. Explicit-access permissions are distinguished by color. A legacy integration with no assigned permissions shows "Billing (legacy access)". * **Last used**: date and time, or "Never used". * **Actions**: **Statistics**, **Logs**, **Edit**, and **Delete** (with confirmation; it cannot be undone). ## Create an integration **1. Go to Integrations → New integration** A side panel opens with three tabs: **General**, **Permissions**, and **Credentials**. **2. General tab: write a descriptive name** For example "POS Downtown Branch" or "Plant biometric clock". Minimum 3 characters. Here you also define whether the integration is active. **3. Permissions tab: check what the external system needs** A new integration starts with Sales, Purchases and expenses, Customers, and Products checked. Adjust the selection and assign only what is necessary. At least one permission is required. **4. Save** FileXpress generates the **API Key** and the **API Secret** and opens the **Credentials** tab so you can copy them. The API Secret is shown only once. > [!WARNING] > > Copy the **API Secret** before closing the panel: it is only shown when you create the integration or when you regenerate it, and it is not shown again. If you lose it, regenerate it. ## General tab * **Basic information**: name and status (active or inactive). * **Rate limit**: shows the integration's requests per minute (100 by default). It is read-only: FileXpress manages it. If a system needs a higher limit, request it from support. ## Permissions tab Permissions are grouped by module. The number next to the tab title indicates how many are selected. * **Search box**: filters permissions by name, description, or endpoint. While a search is active, modules with matches expand on their own. * **Counters**: a line indicates "N of M permissions selected" and each module shows how many of its permissions are checked. * **Select the whole module**: the checkbox in each module's header checks or unchecks all of its permissions; it is in an intermediate state if only some are checked. * **Each permission** shows its description, a **Read-only** or **Read and write** tag (depending on the endpoints it enables) and, expandable, the list of endpoints it exposes. * **Explicit access**: sensitive permissions carry this tag. They must be checked one by one and are not inherited. When you check one, a notice appears saying they expose personal or financial data or move balances and stock. The Human Resources and Accounting modules also show their own warning. * **Full access**: checks all permissions at once, including the explicit-access ones. It asks for confirmation before being applied and leaves the "Full access" tag next to the counter. **Remove all** unchecks the entire selection. | Module | Permissions | | - | - | | Billing | Sales, Purchases and expenses, Currencies and exchange rates, Country capabilities and catalogs, Customers, Suppliers, Products, Points of sale | | Inventory | Inventory queries, Inventory adjustments, Transfers between branches | | Projects | Project queries, Project creation and editing | | Prices and promotions | Prices and promotions, Update prices | | Cash | Cash queries, Operate cash | | Accounts receivable and payable | Accounts receivable, Record collections, Accounts payable, Record supplier payments, Banks, petty cash funds, and checkbooks, Create banks, petty cash funds, and checkbooks | | Human Resources | Employees, Employee creation and editing, Attendance, Leave and vacations, Labor rules, Configure labor rules, Schedules, Configure schedules, Holidays, Configure holidays, Compliance and classified hours, Overtime approval, Payrolls, Payroll cost centers | | Accounting | Chart of accounts, Journal entries, Manage entry types, Financial statements, Cost centers, Manage cost centers, Cost center budgets, Manage budgets | > [!WARNING] > > Explicit-access permissions (**Points of sale**, **Human Resources**, **Accounting**, **Inventory**, **Projects**, **Accounts receivable and payable**, **Prices and promotions**, and **Cash**) expose personal data, salaries, and financial information, or move balances and stock. They are never granted automatically (not even to existing integrations): you have to check them one by one, or use **Full access** deliberately. Enable them only for trusted systems. ### API v2 permissions The **Currencies and exchange rates** (`currencies`) and **Country capabilities and catalogs** (`countries`) permissions belong to the Billing module and are not explicit-access. | Permission | What it is for | Endpoint | | - | - | - | | Currencies and exchange rates | Query the business's active currencies and their exchange rates. | `GET /v2/currencies`, `GET /v2/exchange-rates`, `GET /v2/exchange-rates/resolve` | | Country capabilities and catalogs | Query a country's document types, payment methods, taxes, and billing capabilities. | `GET /v2/countries/{code}` | > [!NOTE] > > An integration that already existed does not receive these permissions on its own if it has assigned permissions: edit it and check them in the **Permissions** tab. ## Credentials tab * **API Key**: shown masked, with buttons to show or hide it and copy it. **Regenerate API Key** generates a new key and the previous one stops working immediately. * **API Secret**: shown hidden. It is only visible when you create the integration or right after regenerating it. **Regenerate API Secret** generates a new secret and the previous one stops working. * **API reference**: expandable section with the base URL, the authentication header (`X-API-Key`), and the endpoints enabled by the checked permissions. Regeneration asks for confirmation. In a new integration, this tab only shows the credentials after saving. > [!NOTE] > > If an API Key is exposed (for example, published by mistake), regenerate it immediately and give the new one to the external system. ## Statistics and logs From the integration's card: * **Statistics**: total requests, successful and failed, average response time, last use, requests per endpoint, and recent errors. * **Logs**: history of each call with endpoint, method, response code, duration, and error message. Useful for diagnosing problems together with the integration provider. ## Common uses | Case | Permissions | | - | - | | POS or online store that issues electronic invoices | Sales, Customers, Products (and Points of sale if the POS creates its own registers) | | ERP that records purchases | Purchases and expenses, Suppliers | | System that invoices in several countries or in foreign currency | Sales, Purchases and expenses, Currencies and exchange rates, Country capabilities and catalogs | | Biometric clock that sends punches | Attendance | | Employee portal to request vacations | Employees, Leave and vacations | | Payroll system or bank that reads payrolls | Payrolls | | External payroll system that pays overtime and surcharges | Compliance and classified hours, Employees | | Shift software that publishes schedules | Configure schedules, Schedules | | Recruiting system that creates new staff | Employees, Employee creation and editing | | BI or audit tool | Financial statements, Chart of accounts | | Warehouse system (WMS) or e-commerce that syncs stock | Inventory queries, Inventory adjustments, Transfers between branches | | Bank or gateway that reconciles collections | Accounts receivable, Record collections | | Treasury system that schedules supplier payments | Accounts payable, Record supplier payments | | Project management tool | Project queries, Project creation and editing | | External system that generates journal entries | Chart of accounts, Journal entries, Cost centers | | ERP that keeps cost centers in sync | Cost centers, Manage cost centers | | BI tool that analyzes results by area | Financial statements, Cost centers | | Payroll system that allocates expense by area | Payrolls, Payroll cost centers, Cost centers | | Supervision system that authorizes overtime | Compliance and classified hours, Overtime approval | | Financial planning tool that loads budgets and tracks their execution | Cost center budgets, Manage budgets, Cost centers, Chart of accounts | | Treasury system that creates bank accounts and checkbooks | Banks, petty cash funds, and checkbooks, Create banks, petty cash funds, and checkbooks, Chart of accounts | | Online store that syncs prices and applies promotions | Prices and promotions, Update prices | | Third-party POS that opens and closes the register | Cash queries, Operate cash | This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.