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
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts?api_key=YOUR_API_KEY"{ "account": { "id": 148306, "address": "Avenida Duque D'Avila, Saldanha", "address_country": "PT", "at_communication_type": "manual", "at_subuser": "12345689/0", "at_configured": true, "billing_address": "Avenida Duque D'Avila, Saldanha", "billing_city": "Lisbon", "billing_country_id": 1, "billing_email": "tito.reis@visma.com", "billing_fiscal_id": "999999990", "billing_organization_name": "invoicexpress", "billing_postal_code": "1500-555", "billing_address_country": "PT", "can_change_nif": false, "capital_social": null, "city": "Lisbon", "conservatoria": null, "currency_id": 1, "decimal_marker": ",", "documents_from_last_year": false, "email": "tito.reis@visma.com", "fiscal_id": "999999990", "fiscal_region": null, "iva_caixa": false, "language": "en", "logo_url": null, "observations": null, "organization_name": "invoicexpress", "payment_days": null, "payment_mechanism": null, "postal_code": "1500-555", "send_options": null, "state": "active", "tax_exemption_code": null, "tax_location_id": 1, "trial": false } }
Ignored. The server always uses password as the confirmation.
Values longer than 100 characters are rejected with HTTP 422.
Required. Missing or blank is rejected with 422 ("VAT Number can't be blank").
Required. Missing or blank is rejected with 422 ("Address can't be blank"); values longer than 210 characters are rejected with HTTP 422.
Required. Missing or blank is rejected with 422 ("Postal code can't be blank").
Required. Missing or blank is rejected with 422 ("City can't be blank"); values longer than 50 characters are rejected with HTTP 422.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts" -H "Content-Type: application/json" --data '{}'SUCCESS
API requests only. Home URL of the new account.
API requests only. API key of the user on the new account.
{ "success": true, "token": "a41f5ef81ad1a93f6e362ef94818ef6497f857745346dba064d081229102e28593818d4496d70fdfe436195a4eed6ed813cd560e043c8fd9aa5889b044d47848", "url": "https://strongsecurity.app.invoicexpress.com", "api_key": "d8117512267a1d84ebb64c65b6294b0719e78134", "redirect": "https://strongsecurity.app.invoicexpress.com" }
Optional. When the account ends up with at_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.
Required. An empty body (no account key and no top-level account field) returns 422 "Param is missing"; top-level account fields are wrapped into account automatically. Only the fields sent are changed.
ISO country code of the billing address.
Marks the billing data as confirmed. Once confirmed it is not changed again.
Cleared (set to null) when billing_country_id is sent with a country other than 1 and no fiscal_region is sent.
Values longer than 200 characters are rejected with HTTP 422.
Values longer than 400 characters are rejected with HTTP 422.
When different from 1 and sent together with fiscal_id, the VAT number is validated for that country; an invalid one returns 422 "VAT Number is invalid".
Values longer than 210 characters are rejected with HTTP 422.
Checked against the AT before saving; rejected credentials return 422 "The tax authority rejected the at_subuser/at_password combination".
Values longer than 50 characters are rejected with HTTP 422.
Values longer than 100 characters are rejected with HTTP 422.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/accounts?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "account": { "id": 148306, "address": "Avenida Duque D'Avila, Saldanha", "address_country": "PT", "at_communication_type": "manual", "at_subuser": "12345689/0", "at_configured": true, "billing_address": "Avenida Duque D'Avila, Saldanha", "billing_city": "Lisbon", "billing_country_id": 1, "billing_email": "tito.reis@visma.com", "billing_fiscal_id": "999999990", "billing_organization_name": "invoicexpress", "billing_postal_code": "1500-555", "billing_address_country": "PT", "can_change_nif": false, "capital_social": null, "city": "Lisbon", "conservatoria": null, "currency_id": 1, "decimal_marker": ",", "documents_from_last_year": false, "email": "tito.reis@visma.com", "fiscal_id": "999999990", "fiscal_region": null, "iva_caixa": false, "language": "en", "logo_url": null, "observations": null, "organization_name": "invoicexpress", "payment_days": null, "payment_mechanism": null, "postal_code": "1500-555", "send_options": null, "state": "active", "tax_exemption_code": null, "tax_location_id": 1, "trial": false } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/years_documents
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/years_documents?api_key=YOUR_API_KEY"{ "years": [ 2026, 2025, 2024, 2023 ] }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/export
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/export?api_key=YOUR_API_KEY&data_type=invoices&data_format=xls"{ "message": "We'll send you an email when it's done to: info@test.com." }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/billing_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/billing_history?api_key=YOUR_API_KEY&page=1&per_page=10"{ "billing_history": [ { … } ], "pagination": { "total_entries": 0, "current_page": 1, "total_pages": 0, "per_page": 10 } }
Email (login) of the existing user.
Values longer than 100 characters are rejected with HTTP 422.
Required. Missing or blank is rejected with 422 ("VAT Number can't be blank").
Required. Missing or blank is rejected with 422 ("Address can't be blank"); values longer than 210 characters are rejected with HTTP 422.
Required. Missing or blank is rejected with 422 ("Postal code can't be blank").
Required. Missing or blank is rejected with 422 ("City can't be blank"); values longer than 50 characters are rejected with HTTP 422.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/create_already_user
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/create_already_user" -H "Content-Type: application/json" --data '{}'CREATED
API requests only. Home URL of the new account.
API requests only. API key of the user on the new account.
{ "success": true, "token": "a41f5ef81ad1a93f6e362ef94818ef6497f857745346dba064d081229102e28593818d4496d70fdfe436195a4eed6ed813cd560e043c8fd9aa5889b044d47848", "url": "https://strongsecurity.app.invoicexpress.com", "api_key": "d8117512267a1d84ebb64c65b6294b0719e78134", "redirect": "https://strongsecurity.app.invoicexpress.com" }
Documents tab whose settings are returned. Plural and lowercase forms are also accepted (invoices, estimate, guides, ...); they are singularized and capitalized. Any other value returns 422 (Tab <value> doesn't exist); omitting the parameter returns 500.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/settings
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/settings?api_key=YOUR_API_KEY&documents_tab=Invoice"{ "currency_separator": ",", "currency_symbol": "€", "currency_code": "EUR", "language": "en", "sequence_number_mode": "auto", "batch_import_rule": true, "first_document": true, "logo_url": "https://aws-s3-url-logo.com", "account_name": "Company Test" }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/users
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/users?api_key=YOUR_API_KEY"{ "users": [ { … } ], "pagination": { "total_entries": 3, "current_page": 1, "total_pages": 1, "per_page": 10 } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/users
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/accounts/users?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "user": { "id": 147436, "email": "tito.reis@visma.com", "phone_country_id": 1, "role": "contributor" } }
Required. A JSON body without the user key is wrapped into user automatically, so it fails with 422 "Role is invalid" rather than 500.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/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/accounts/users/1?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"user":{"role":"administrator"}}'{ "user": { "id": 147436, "email": "tito.reis@visma.com", "phone_country_id": 1, "role": "contributor" } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/users/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/accounts/users/1?api_key=YOUR_API_KEY"- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization?api_key=YOUR_API_KEY"SUCCESS
Whether the série given in serie_name has its own customization (instead of using the account's). Always false without serie_name.
Values longer than 100 characters are rejected with HTTP 422.
Values longer than 210 characters are rejected with HTTP 422.
Values longer than 50 characters are rejected with HTTP 422.
{ "has_series_configuration": false, "organization_name": "invoicexpress", "fiscal_id": "999999990", "address": "Avenida Duque D'Avila, Saldanha", "postal_code": "1500-555", "city": "Lisbon", "country": "Portugal", "share_capital": null, "register_office": null, "logo_url": "", "remarks": null, "footer": null, "document_copies": 1, "payment_days": 0, "email": "tito.reis@visma.com", "phone": null, "website": null, "phone_country_id": 1, "tax_exemption_code": null, "bank_data_type_1": null, "bank_data_value_1": "", "bank_data_type_2": null, "bank_data_value_2": "", "bank_data_type_3": null, "bank_data_value_3": "" }
Request
Replaces the document customization of the account (or of one série, with serie_name).
This is a full replace: every customization field that is not sent (or is sent blank) is set to null. Send all the values you want to keep, not only the ones you change. See the request body for the list of fields.
- application/json
- multipart/form-data
Default document observations. Maximum 400 characters ("observations_too_long"). Account level only.
Document footer. Maximum 200 characters ("invoice_footer_too_long").
When set, bank_data_value_2 is required ("bank_data2_blank").
Name of a série of the account. When present, the customization of that série is replaced instead of the account's.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"email":"billing@example.com","phone":"213456789","website":"https://example.com","phone_country_id":1,"tax_exemption_code":"M07","remarks":"Thank you for your business.","footer":"Company registered in Lisbon.","document_copies":2,"payment_days":15,"bank_data_type_1":"IBAN","bank_data_value_1":"PT50000201231234567890154"}'{ "success": true, "logo_error": "logo_upload_failed" }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/accounts/document_customization?api_key=YOUR_API_KEY"{ "success": true }
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.