Create quotes, proformas and fees notes and send them to your clients.
InvoiceXpress API (3.1.0)
The InvoiceXpress v3 API: invoicing documents (invoices, guides, estimates) and their series, clients, items, taxes, schedules and favorites; account, user, AT-communication and payment-service settings; batch CSV imports of invoices, products and clients; dashboard KPIs, reports, SAF-T export, digital signatures, EDI (CIUS-PT), Social Security declarations, and reference lists (currencies, tax countries, phone calling codes).
What changed between versions of this reference is listed under Changelog, at the end of the navigation.
Results per page (default 10). items_per_page and page_items are accepted as aliases.
Search text. Matches items whose name (code) or description contains it.
Field to sort by (default products.name).
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/items
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/items?api_key=YOUR_API_KEY&page=1&per_page=10&term=Consult&sort=name&sort_order=ASC"{ "items": [ { … } ], "pagination": { "total_entries": 1, "current_page": 1, "total_pages": 1, "per_page": 10 } }
Item fields accepted on create and update. Any other key inside item is ignored.
Item name/code. Values longer than 60 characters are rejected with HTTP 422 (Code for the item is too long (maximum should be 60 characters)) — they are not truncated. On update, it cannot be changed once the item is used in a non-draft document (HTTP 422 Code can't be changed because it is already associated with invoices).
Values longer than 200 characters are rejected with HTTP 422 (Description is too long (maximum is 200 characters)) — they are not truncated.
A missing or non-numeric value is rejected with HTTP 422 (Price is not valid. Check the decimal mark and if you are inserting only numbers.).
Recommended retail price. On create, when omitted, it is computed as unit_price plus the item's tax. On update, an omitted value is left unchanged.
One of: hour, day, month, unit, service, tax, other, product, article. On create, defaults to service when omitted; on update, an omitted unit is left unchanged.
Tax of the item, by name. When omitted, create uses the account's default tax and update keeps the current tax. An unknown name is rejected on create with HTTP 422 (Tax must exist); on update it is ignored and the current tax is kept.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/items
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/items?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "item": { "id": 1, "code": "Item name", "description": "Item description", "unit_price": 9.99, "rrp": 12.29, "unit": "service", "tax": { … }, "retention": 2 } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/items/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/items/1?api_key=YOUR_API_KEY"{ "item": { "id": 1, "code": "Item name", "description": "Item description", "unit_price": 9.99, "rrp": 12.29, "unit": "service", "unit_sold": 16, "total_sold": 196.8, "total_sold_before_taxes": 160, "currency": { … }, "tax": { … }, "retention": 2 } }
Item fields accepted on create and update. Any other key inside item is ignored.
Item name/code. Values longer than 60 characters are rejected with HTTP 422 (Code for the item is too long (maximum should be 60 characters)) — they are not truncated. On update, it cannot be changed once the item is used in a non-draft document (HTTP 422 Code can't be changed because it is already associated with invoices).
Values longer than 200 characters are rejected with HTTP 422 (Description is too long (maximum is 200 characters)) — they are not truncated.
A missing or non-numeric value is rejected with HTTP 422 (Price is not valid. Check the decimal mark and if you are inserting only numbers.).
Recommended retail price. On create, when omitted, it is computed as unit_price plus the item's tax. On update, an omitted value is left unchanged.
One of: hour, day, month, unit, service, tax, other, product, article. On create, defaults to service when omitted; on update, an omitted unit is left unchanged.
Tax of the item, by name. When omitted, create uses the account's default tax and update keeps the current tax. An unknown name is rejected on create with HTTP 422 (Tax must exist); on update it is ignored and the current tax is kept.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/items/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/items/1?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "item": { "id": 1, "code": "Item name", "description": "Item description", "unit_price": 9.99, "rrp": 12.29, "unit": "service", "tax": { … }, "retention": 2 } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/items/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/items/1?api_key=YOUR_API_KEY"Changelog
Changes to the documented contract of the InvoiceXpress API v3: endpoints, fields, enum values, status codes and behaviour you can observe as an integrator. The newest version is at the top.
The version number is the one shown at the top of this reference, and it follows these rules:
- Minor (
3.1.0): something was added, such as a new endpoint, field or enum value. Existing integrations keep working. - Patch (
3.0.1): the documentation was corrected and now describes what the API already did. No behaviour changed. - The major version stays at
3. A change that would break existing integrations is released as a new API version, not as4.0.0of this one.
Social SecurityCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code
Helps self-employed accounts (trabalhadores independentes and ENI) fill in the quarterly income declaration for Segurança Social. InvoiceXpress calculates the quarter's totals from your invoices and an estimate of the monthly contribution; you record what you reported.
This feature submits nothing to Segurança Social. You type the figures into Segurança Social Direta yourself. It only calculates and records.
Authentication is
api_keyonly, and every endpoint is JSON only. The declaration endpoints are served under/services/v1/social_security/...and the settings and report endpoints under/api/v3/accounts/..., all on the v3 host.