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/accounts/at_active_communication
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/at_active_communication?api_key=YOUR_API_KEY&context=Sequences&type=AT"{ "account": { "fiscal_id": "999999990", "at_user": null, "legacy_credentials_present": true, "account_credentials_present": false } }
Required. A missing at_communication key returns 500.
Required unless communication_type is manual. Must contain /. Omitting it (with a non-manual communication_type) fails with 500 ("undefined method 'include?' for nil"); only an empty string gives 422.
Required unless communication_type is manual. Checked against the AT.
Optional. When the account ends up with communication_type auto (and is not a SAF-T big account), the documents of the chosen years are communicated to the AT retroactively. Any other value communicates nothing retroactively.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/at_communication
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/at_communication?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "success": true }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/at_communication_history
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/at_communication_history?api_key=YOUR_API_KEY&page=1&per_page=10"{ "communication_history": [ { … } ], "pagination": { "total_entries": 0, "current_page": 1, "total_pages": 0, "per_page": 10 } }
context and type are always required. username and password are required on PUT, and on POST unless use_legacy_credentials is true. The username must start with the account's NIF (format NIF/subuser).
Stored encrypted (AES-256-CBC, Base64-encoded), so the usable plaintext length is meaningfully shorter than the underlying column width. No exact limit is published.
POST only. When true, the credentials are copied from the account's existing (legacy) AT communication details instead of username/password, which may then be omitted. Fails with 422 when the account has no legacy credentials or already has credentials.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/account_credentials
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/account_credentials?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "success": true, "http_code": "created" }
context and type are always required. username and password are required on PUT, and on POST unless use_legacy_credentials is true. The username must start with the account's NIF (format NIF/subuser).
Stored encrypted (AES-256-CBC, Base64-encoded), so the usable plaintext length is meaningfully shorter than the underlying column width. No exact limit is published.
POST only. When true, the credentials are copied from the account's existing (legacy) AT communication details instead of username/password, which may then be omitted. Fails with 422 when the account has no legacy credentials or already has credentials.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/account_credentials
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/account_credentials?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "success": true, "http_code": "created" }
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.