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.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/users/1?api_key=YOUR_API_KEY"{ "user": { "id": 1, "name": "Jean Dias", "email": "john.doe@invoicexpress.com", "phone": "987654321", "phone_country_id": 1, "accepted_marketing": true } }
Request
Updates the current account user's profile.
The email (and login) cannot be changed here. user.email / user.login may be sent only with the current value; a different value rejects the whole request with 422. Email changes go through POST /api/v3/users/{id}/email_change.
user.name is saved as first_name. To change the password, send actual_password (current password), password and password_confirmation.
Required. An empty body (no user root and no top-level user field) returns 500; top-level user fields (e.g. first_name, phone) are wrapped into user automatically.
To change the password, send actual_password (current password), password and password_confirmation.
Saved as first_name (it overrides first_name when both are sent). No enforced character limit (text column).
Cannot be changed through this endpoint. Optional; if sent it must equal the user's current email (case-insensitive), otherwise the whole request is rejected with 422 "Email changes must be requested through POST /users/:id/email_change." The same applies to login. To change the email use POST /api/v3/users/{id}/email_change.
Current password. Required to change the password (see above).
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/users/1?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "user": { "id": 1, "name": "Jean Dias", "email": "john.doe@invoicexpress.com", "phone": "987654321", "phone_country_id": 1, "accepted_marketing": true } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/{id}/api_key
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/users/1/api_key?api_key=YOUR_API_KEY"{ "account_name": "companyname", "api_key": "aa8e739bbcbb406c90eccbe0825e87c5c1c4c5a9" }
Request
Generates a new API key for the caller on the current account.
Warning: this regenerates the key. If the caller already has an API key, it is replaced and the old one stops working immediately, including the key used to make this request.
The id path parameter is ignored: the call always acts on the caller.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/{id}/api_key
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/users/1/api_key?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "account_name": "companyname", "api_key": "aa8e739bbcbb406c90eccbe0825e87c5c1c4c5a9" }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/{id}/api_key
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/users/1/api_key?api_key=YOUR_API_KEY"- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/{id}/accounts
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/users/1/accounts?api_key=YOUR_API_KEY"{ "accounts": [ { … } ] }
Optional. Language of the response messages. It can also be sent as a query parameter. Without it (or with another value) the messages use Portuguese (pt).
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/recover_password
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/users/recover_password" -H "Content-Type: application/json" --data '{}'{ "message": "We've sent a link to reset your password to your email address." }
Optional. Language of the response messages. It can also be sent as a query parameter. Without it (or with another value) the messages use the language of the user's account, or Portuguese (pt) when the reset code is invalid.
New password. Must differ from the current one (Password can't be identical to the current one).
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/users/reset_password
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/users/reset_password" -H "Content-Type: application/json" --data '{}'{ "message": "Password successfully reset." }
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.