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

Calculate Estimate Summary

Request

Calculates the totals (sum, discount, taxes, retention, total) for the items sent, without validating or saving anything. Unlike update_summary, invalid input is coerced instead of rejected: a missing or wrongly named wrapper key, or no items, returns an all-zero summary with 200. Only items, retention, global_discount, currency_code, rate and tax_exemption are read; at most 1000 items are processed. The wrapper key is the singular of the path type (quote, proforma, fees_note).

Security
apiKeyAuth
Path
estimate_typestringrequired

Type of estimate document (quotes, proformas, fees_notes).

Enum"quotes""proformas""fees_notes"
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/json
quoteobject
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/quotes/calculate_summary?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"quote":{"items":[{"name":"Service A","unit_price":100,"quantity":2,"tax":{"name":"IVA23"}}]}}'

Responses

SUCCESS

Bodyapplication/json
summaryobject
Response
application/json
{ "summary": { "sum": 200, "discount": 0, "before_taxes": 200, "taxes": 46, "total": 246, "currency": { … }, "retention": 0, "pay_progress": 0, "to_pay": 246, "total_paid": 0, "taxes_breakdown": [ … ], "total_currency_rate": 0, "rate": 1 } }

New Estimate Defaults

Request

Returns the defaults and choices needed to build a new estimate of the given type (due-date options, exemption reasons, issuable sequences, currencies, retention options, default remarks, taxes). Nothing is created. When client_id is sent, the client's payment days, exemption code, currency and observations take priority over the account's.

Security
apiKeyAuth
Path
estimate_typestringrequired

Type of estimate document (quotes, proformas, fees_notes).

Enum"quotes""proformas""fees_notes"
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
client_idinteger

Id of a client of the account, used to pre-select client-specific defaults and return a short client object.

curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/quotes/new?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
due_date_choicesArray of objects

Due-date options in days. The one matching the client's (or else the account's) payment days is flagged selected; a value not in the list replaces the last ("Other") entry.

Example: [{"value":0,"description":"Immediately"},{"value":15,"description":"15 days"},{"value":30,"description":"30 days","selected":true},{"value":"custom","description":"Other"}]
exemption_reasonsArray of objects

VAT exemption reasons; the client's (or account's) code is flagged selected.

sequencesArray of objects

Sequences of this estimate type available for issuing (only AT-registered ones for Portuguese accounts). The account's current serie is flagged selected. When there are none, a single disabled placeholder entry with id null is returned ("Choose a registered Sequence", or "Choose a Sequence" for foreign accounts).

currenciesArray of objects

Available currencies; the client's currency is flagged selected.

retentionArray of objects

Withholding-tax options. The first entry ("Not applicable") has id and value null.

Example: [{"id":null,"value":null,"description":"Not applicable"}]
remarksstring

Default observations (client's, else account's) followed by the exemption reason text, if any.

include_payment_referenceboolean or null

Null unless the plan has MB references, a payment provider is configured and the type supports payment references; then the account's estimate setting.

has_configured_payment_serviceboolean
Example: false
auto_send_invoice_from_estimateboolean
Example: false
taxesArray of objects
clientobject

Present only when a known client_id query parameter is sent.

Response
application/json
{ "due_date_choices": [ { … }, { … }, { … }, { … } ], "exemption_reasons": [ { … } ], "sequences": [ { … } ], "currencies": [ { … } ], "retention": [ { … } ], "remarks": "string", "include_payment_reference": true, "has_configured_payment_service": false, "auto_send_invoice_from_estimate": false, "taxes": [ { … } ], "client": { "id": 0, "name": "string", "fiscal_id": "string", "address": "string", "postal_code": "string", "city": "string", "country": "string" } }

Get Estimate by ID

Request

Retrieves detailed information about a specific estimate document including client data, items, financial summary, and account information.

Security
apiKeyAuth
Path
estimate_typestringrequired

Type of estimate document (quotes, proformas, fees_notes).

Enum"quotes""proformas""fees_notes"
idintegerrequired

The document ID.

Example: 541674
Query
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Bodyapplication/json
quoteobject

Wrapper key matches the singular of the requested estimate type (quote, proforma, or fees_note).

Response
application/json
{ "quote": { "id": 257118662, "status": "draft", "archived": false, "type": "Quote", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259462, "atcud": "N/A", "date": "2026-05-11", "due_date": "2026-06-11", "reference": null, "observations": null, "token": "2571186625ad1072ab31349f6c7c6bd919c2547e43c965aa1", "permalink": "https://web.invoicexpress.com/documents/2571186625ad1072ab31349f6c7c6bd919c2547e43c965aa1?language=pt", "retention": 0, "global_discount": null, "owner_invoice_id": null, "raw_owner_invoice": "FT 2026/253", "currency": null, "auto_add_related_document": false, "qr_code": "https://example.com/qr_codes/264663413.png", "digital_signed": false, "include_payment_reference": false, "auto_send_invoice_from_estimate": false, "account": { … }, "client": { … }, "items": [ … ], "summary": { … } } }

Sequences

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

Operations

Clients

A Client is an entity you send invoices to.

Operations

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.