Skip to content

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.

Authentication

Send your api_key as a query parameter on JSON (or XML) requests. A request with no valid api_key answers 401. The Authorization: Bearer and X-Account headers authenticate the InvoiceXpress web app only; they are not meant for API clients. Endpoints marked as public need no key.

Download OpenAPI description
Overview
InvoiceXpress API Support
Languages
Servers
Production Server
https://api-v3.app.invoicexpress.com/

Invoices

Create invoices, invoice receipts, simplified invoices, vat moss invoices, credit notes & debit notes and send them to your clients.

Operations

Guides

Create shippings, transports & devolutions and send them to your clients.

Operations

Estimates

Create quotes, proformas and fees notes and send them to your clients.

Operations

Sequences

A Sequence is used to group invoices in a sequential order.

Operations

Clients

A Client is an entity you send invoices to.

Operations

Get Client Suggestions

Request

Returns client suggestions. With client_text, searches the account's clients by that text. Without it, returns the last clients used on documents of the document_tab family (at most 10, most recent first); an empty list when none were recorded.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
document_tabstring

Document family whose last used clients are returned when client_text is absent. documents_tab is accepted as an alias. Ignored when client_text is sent.

Enum"Invoices""Estimates""Guides"
Example: document_tab=Invoices
client_textstring

Search text to find clients from the current account.

Example: client_text=John
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/clients/suggestions?api_key=YOUR_API_KEY&document_tab=Invoices&client_text=John"

Responses

SUCCESS

Bodyapplication/json
clientsArray of objects(V3ClientSuggestionItem)
Response
application/json
{ "clients": [ { … } ] }

Get Client

Request

Returns a specific client by ID.

Security
apiKeyAuth
Path
idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/clients/1?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
clientobject(V3ClientObject)

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.

Response
application/json
{ "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 } }

Update Client

Request

Updates an existing client. Partial update — only the keys sent inside client are changed.

Security
apiKeyAuth
Path
idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
clientobjectrequired

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.

client.​namestring<= 100 characters
Example: "John Doe"
client.​codestring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "12345"
client.​languagestring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "pt"
client.​emailstring<= 254 characters
Example: "john.doe@invoicexpress.com"
client.​addressstring

No enforced character limit (text column).

Example: "Avenida da República, Lisboa"
client.​citystring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "Lisboa"
client.​postal_codestring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "1050-555"
client.​fiscal_idstring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "123456789"
client.​websitestring<= 60 characters
Example: "www.invoicexpress.com"
client.​countrystring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "Portugal"
client.​address_countrystring or null

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.

Example: "PT"
client.​phonestring<= 20 characters
Example: "963214569"
client.​phone_country_idinteger
Example: 1
client.​mobilestring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "999999999"
client.​mobile_country_idinteger
Example: 1
client.​faxstring<= 20 characters
Example: "213456789"
client.​preferred_contactobject
client.​observationsstring or null

No enforced character limit (text column).

Example: null
client.​send_optionsinteger
Example: 1
client.​payment_daysinteger
Example: 0
client.​tax_exemption_codestring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "M00"
client.​payment_mechanismstring<= 255 characters

Maximum length is the database default, not an enforced business rule.

Example: "MB"
client.​currency_idinteger
Example: 1
client.​use_account_settingsboolean

Update only (ignored on create). When true, after the other fields are saved the client's tax_exemption_code, payment_mechanism, language, currency_id, payment_days, send_options and observations are cleared, so the account defaults apply.

Example: true
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/clients/1?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
clientobject(V3ClientObject)

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.

Response
application/json
{ "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 } }

Accounts

Manage your InvoiceXpress account settings, users, AT communication, and billing.

Operations

Account Credentials

Manage AT communication credentials for your account.

Operations

Collection Alerts

Configure automated payment collection alerts sent to clients.

Operations

Batch Invoices

Bulk-create invoices from a CSV file. Flow — GET batch → upload → process → mapping → configure_options → configure → validate → validation → available_docs → POST create → status. DELETE to discard.

Operations

Batch Products

Bulk import products from a CSV file. Flow — GET index (optional) → upload → process → GET/PUT mapping → validate → validation → POST create → status. DELETE to discard.

Operations

Batch Clients

Bulk import clients from a CSV file. Flow — GET index (optional) → upload → process → GET/PUT mapping → validate → validation → POST create → status. DELETE to discard. No configure step.

Operations

Items

An Item is the product or service you invoice.

Operations

Schedules

Create and manage recurring document schedules.

Operations

Taxes

Manage tax rates for your account.

Operations

Current User

Manage the currently authenticated user's own profile, API key, linked accounts, and password recovery.

Operations

Currencies

List supported currencies and look up exchange rates between them.

Operations

Dashboard

Retrieve dashboard KPIs and analytics about your clients and invoicing activity.

Operations

Favorites

Save and reuse custom filter presets for documents and other list views.

Operations

Payment Services

Configure and manage the payment service integration used to collect payments for your invoices.

Operations

Phone Calling Codes

List all phone country calling codes.

Operations

Reports

Reporting endpoints — currently covers the balance-per-client report, its summary, and XLSX export.

Operations

SAF-T

Generate the SAF-T (Standard Audit File for Tax) export for your account.

Operations

Tax Countries

List all tax countries.

Operations

Digital signatures

Allows opt-in for available digital signature providers, manage its credentials, and sign invoices.

Operations

EDI

Manage electronic invoice (CIUS-PT) generation and its additional customs/delivery fields. Note these endpoints are served under /api/v1/edi/ on the v3 host, and address documents by a bare id with no document-type segment.

Operations

Social Security

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_key only, 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.

Operations

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 as 4.0.0 of this one.