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.
Client fields accepted on create and update. Any other key inside client is ignored. Sending initial_balance inside client is not supported: the request fails with HTTP 500. Use PUT /api/v3/clients/{id}/initial_balance instead.
Maximum length is the database default, not an enforced business rule.
Maximum length is the database default, not an enforced business rule.
No enforced character limit (text column).
Maximum length is the database default, not an enforced business rule.
Maximum length is the database default, not an enforced business rule.
Maximum length is the database default, not an enforced business rule.
Maximum length is the database default, not an enforced business rule.
ISO country code of the client's address. Stored as sent (an unknown code is kept as received); send it empty or null to clear it. Omit the key to leave the stored value unchanged.
Maximum length is the database default, not an enforced business rule.
Maximum length is the database default, not an enforced business rule.
Maximum length is the database default, not an enforced business rule.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/clients/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/clients/1?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'SUCCESS
Client as returned by show, create, update, archive and unarchive. country is omitted when the client has none. These fields fall back to the account's own value when the client has none of its own: language, observations, send_options, document_copies (same value as send_options), payment_days, tax_exemption_code, payment_mechanism and currency_id. use_account_settings is true when the client has none of these set itself.
{ "client": { "id": 191880320, "name": "John Doe", "code": "JS", "language": "en", "email": "john.doe@invoicexpress.com", "address": "Avenida da República, Lisboa", "city": "Lisboa", "postal_code": "1050-555", "fiscal_id": "123456789", "website": null, "country": "Portugal", "address_country": "PT", "phone": null, "phone_country_id": 1, "mobile": null, "mobile_country_id": null, "fax": null, "preferred_contact": { … }, "observations": null, "open_account_link": "http://www.app.invoicexpress.com/suppliers/47888a650591050dfc40e4511fe9da18db165cb4", "document_copies": null, "send_options": null, "payment_days": null, "tax_exemption_code": null, "payment_mechanism": null, "currency_id": 1, "use_account_settings": true, "consumidor_final": false, "can_be_deleted": false, "archived": false, "archived_at": null } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/clients/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/clients/1?api_key=YOUR_API_KEY"Request
Archives a client. Archiving hides the client from GET /api/v3/clients?status=active and nothing else: the client can still be read and updated, documents created through the API can still use it, and it still counts when another client is created with the same name or code. Use it for clients that cannot be deleted (can_be_deleted is false), but any client can be archived. No request body. Archiving an archived client succeeds and keeps the original archived_at.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/clients/{id}/archive
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/clients/12345/archive?api_key=YOUR_API_KEY"SUCCESS — the client, with archived and archived_at updated
Client as returned by show, create, update, archive and unarchive. country is omitted when the client has none. These fields fall back to the account's own value when the client has none of its own: language, observations, send_options, document_copies (same value as send_options), payment_days, tax_exemption_code, payment_mechanism and currency_id. use_account_settings is true when the client has none of these set itself.
{ "client": { "id": 191880320, "name": "John Doe", "code": "JS", "language": "en", "email": "john.doe@invoicexpress.com", "address": "Avenida da República, Lisboa", "city": "Lisboa", "postal_code": "1050-555", "fiscal_id": "123456789", "website": null, "country": "Portugal", "address_country": "PT", "phone": null, "phone_country_id": 1, "mobile": null, "mobile_country_id": null, "fax": null, "preferred_contact": { … }, "observations": null, "open_account_link": "http://www.app.invoicexpress.com/suppliers/47888a650591050dfc40e4511fe9da18db165cb4", "document_copies": null, "send_options": null, "payment_days": null, "tax_exemption_code": null, "payment_mechanism": null, "currency_id": 1, "use_account_settings": true, "consumidor_final": false, "can_be_deleted": false, "archived": false, "archived_at": null } }
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.