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

Get Document by ID

Request

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

Security
apiKeyAuth
Path
invoices-typestringrequired

The type of the invoice document. receipts (payment receipts) is accepted here; receipts have no create, update, clone or /new (those operations use DocumentTypeInvoiceParam).

Enum"invoices""invoice_receipts""simplified_invoices""credit_notes""debit_notes""receipts"
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/invoices/541674?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
invoiceobject

Wrapper key matches the singular of the requested invoice type (invoice, invoice_receipt, simplified_invoice, credit_note, debit_note, or receipt).

For the receipt wrapper (payment receipts) the shape differs: items are the payments the receipt covers, each {document_type, document_sequence_number, total, paid} (e.g. {"document_type": "Invoice", "document_sequence_number": "2026/12", "total": 123.0, "paid": 123.0}) instead of product lines; account.bank_data and auto_add_related_document are not returned.

Response
application/json
{ "invoice": { "id": 264663413, "status": "draft", "cancel_reason": "document was duplicated", "archived": false, "type": "Invoice", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259451, "atcud": "N/A", "saft_hash": "FoIq", "tax_exemption": "M01", "date": "2026-07-27", "due_date": "2026-08-27", "reference": null, "observations": null, "token": "2646634130360dcbca24d2d9509add7c92ccb1d7ab970ce6d", "permalink": "https://web.invoicexpress.com/documents/2646634130360dcbca24d2d9509add7c92ccb1d7ab970ce6d?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, "account": { … }, "client": { … }, "items": [ … ], "summary": { … }, "mb_reference": { … } } }

Update Invoice-type Document

Request

Updates a document of the specified invoice type and returns it. The id must belong to a document of that type. The request body wrapper key must be the singular of the path segment (invoice, invoice_receipt, simplified_invoice, credit_note, debit_note). The body accepts the same fields as create, and items must again contain at least one item: the item list sent replaces the stored one.

Documents in status sent, settled, deleted, canceled, accepted, refused or second_copy cannot be changed (422 "Document has been finalized so can't be changed anymore").

Security
apiKeyAuth
Path
invoices-typestringrequired

The type of the invoice document.

Enum"invoices""invoice_receipts""simplified_invoices""credit_notes""debit_notes"
idintegerrequired

The document ID.

Example: 541674
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
proprietary_uidstring

Your own idempotency identifier for the document. Accepted here at the top level or inside the wrapper; a repeated value returns the document already created with it instead of creating a new one.

Example: "order-10045"
invoiceobject
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/invoices/541674?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"invoice":{"date":"2026-07-27","due_date":"2026-08-27","client":{"id":456},"items":[{"name":"Product Name","unit_price":100,"quantity":1}]}}'

Responses

SUCCESS

Bodyapplication/json
invoiceobject

Wrapper key matches the singular of the requested invoice type (invoice, invoice_receipt, simplified_invoice, credit_note, or debit_note).

Response
application/json
{ "invoice": { "id": 541674, "status": "final", "cancel_reason": "document was duplicated", "archived": false, "type": "Invoice", "sequence_number": "2024/001", "inverted_sequence_number": "001/2024", "sequence_id": 123, "owner_invoice_id": 541673, "atcud": "ATCUD123456", "saft_hash": "1234", "tax_exemption": "M01", "date": "2024-01-15", "due_date": "2024-02-15", "reference": "REF001", "observations": "Payment terms: 30 days", "token": "541674bbfcdd182143fe2747524df08ab1367ef8255010", "permalink": "https://web.invoicexpress.com/documents/541674bbfcdd182143fe2747524df08ab1367ef8255010?language=pt", "retention": 0, "global_discount": 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, "account": { … }, "client": { … }, "items": [ … ], "summary": { … }, "mb_reference": { … } } }

Get New Document Defaults

Request

Returns the defaults and choice lists used to build a new document of the specified invoice type (payment terms, exemption reasons, series of that type, currencies, retention options, taxes and default remarks). Nothing is created.

Security
apiKeyAuth
Path
invoices-typestringrequired

The type of the invoice document.

Enum"invoices""invoice_receipts""simplified_invoices""credit_notes""debit_notes"
Query
client_idinteger

Id of a client of the account. Its payment days, exemption code, currency and observations are used for the defaults, and its basic data is returned in client.

Example: client_id=196600840
api_keystringrequired

Your API Key.

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

Responses

SUCCESS

Bodyapplication/json
due_date_choicesArray of objects

Payment-term options in days. The client's (or account's) payment days are flagged selected; a value outside the fixed list replaces the custom entry.

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

Series of this document type the account can issue in (Portuguese accounts only list series registered with the AT). When there is none, a single placeholder entry is returned with id null, disabled true and serie "Choose a registered Sequence" (or "Choose a Sequence" for foreign accounts).

currenciesArray of objects
retentionArray of objects

Withholding-tax options. The first entry (id and value null, "Not applicable") means no retention.

remarksstring

Default observations — the client's (or account's) observations followed by the text of the default exemption reason.

Example: ""
include_payment_referenceboolean or null

The account's "add Multibanco reference by default" preference. Null unless the plan includes MB, an MB provider is configured and the document type supports a payment reference.

Example: null
has_configured_payment_serviceboolean
Example: false
taxesArray of objects
clientobject

Conditional — only present when client_id matches a client.

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

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

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.