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

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

Download CIUS-PT File

Request

Generates and downloads the CIUS-PT (electronic invoice) file for a document. The operation is asynchronous: while the file is being generated the response body is {"generating": true}; keep polling until the body contains key and url.

Both cases return HTTP 200 — unlike the SAF-T export and the PDF and QR code endpoints, this endpoint does not return 202 while generating. The only difference is which fields are present in the body.

Note that this endpoint takes a bare document id with no document-type segment, so any document in the account can be addressed. Only Invoice, InvoiceReceipt, SimplifiedInvoice, DebitNote and CreditNote documents are eligible — VAT MOSS invoices are not, and return 406. Draft documents also return 406.

Security
apiKeyAuth
Path
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/v1/edi/541674/cius-pt?api_key=YOUR_API_KEY"

Responses

SUCCESS — key and url when the file is ready, generating: true while it is still being generated

Bodyapplication/json
One of:

Returned when the CIUS-PT file is ready. The body is not wrapped.

keystring

S3 object key of the generated file.

Example: "production/148306/267339734/settled-cius-pt.xml"
urlstring(uri)

Pre-signed S3 download URL, valid for 7 days.

Example: "https://invoicexpress-cius-xml.s3.eu-west-1.amazonaws.com/production/148306/267339734/settled-cius-pt.xml?response-content-disposition=attachment&X-Amz-Expires=604800"
Response
application/json
{ "key": "production/148306/267339734/settled-cius-pt.xml", "url": "https://invoicexpress-cius-xml.s3.eu-west-1.amazonaws.com/production/148306/267339734/settled-cius-pt.xml?response-content-disposition=attachment&X-Amz-Expires=604800" }

Get CIUS Additional Fields

Request

Returns the CIUS/EDI additional fields (order and delivery references, accounting cost, delivery date) associated with a document. Every field is always present in the response; each one is null when no additional fields have been stored for the document yet.

Security
apiKeyAuth
Path
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/v1/edi/541674/additional_fields?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
additional_fieldsobject
Response
application/json
{ "additional_fields": { "order_reference": "PO-2026-0042", "accounting_cost": "Cost centre 4711", "contract_document_reference": "CT-2026-118", "despatch_document_reference": "DES-2026-0091", "originator_document_reference": "ORIG-2026-0007", "actual_delivery_date": "2026-06-01" } }

Create or Update CIUS Additional Fields

Request

Creates the document's CIUS/EDI additional fields, or updates them if they already exist — the same endpoint serves both cases. Returns 201 when the record is created and 200 when an existing record is updated.

Fields omitted from the payload keep their stored value, so this is a partial update rather than a replace.

Security
apiKeyAuth
Path
idintegerrequired

The document ID.

Example: 541674
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
additional_fieldsobjectrequired

All fields are optional, but the additional_fields wrapper itself is required. Fields omitted from the payload keep their stored value — this is a partial update, not a replace.

additional_fields.​order_referencestring
Example: "PO-2026-0042"
additional_fields.​accounting_coststring
Example: "Cost centre 4711"
additional_fields.​contract_document_referencestring
Example: "CT-2026-118"
additional_fields.​despatch_document_referencestring
Example: "DES-2026-0091"
additional_fields.​originator_document_referencestring
Example: "ORIG-2026-0007"
additional_fields.​actual_delivery_datestring(date)

Delivery date in YYYY-MM-DD format. Any value that cannot be parsed as a date returns 422.

Example: "2026-06-01"
curl -X POST "https://api-v3.app.invoicexpress.com/api/v1/edi/541674/additional_fields?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"additional_fields":{"order_reference":"PO-2026-0042","actual_delivery_date":"2026-06-01"}}'

Responses

SUCCESS — existing additional fields updated

Bodyapplication/json
additional_fieldsobject
Response
application/json
{ "additional_fields": { "order_reference": "PO-2026-0042", "accounting_cost": "Cost centre 4711", "contract_document_reference": "CT-2026-118", "despatch_document_reference": "DES-2026-0091", "originator_document_reference": "ORIG-2026-0007", "actual_delivery_date": "2026-06-01" } }

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.