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

Get Balance Per Client Report

Request

Returns a paginated list of balances per client, with optional date-range, client, and tax filtering.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
pageinteger>= 1

Page number for pagination, starting at 1. 0 or a negative value answers 500.

Default 1
Example: page=1
per_pageinteger>= 1

Number of items per page. No maximum is enforced.

Default 10
Example: per_page=10
date_fromstring(date)

Start date for filtering (format YYYY-MM-DD). Defaults to 1900-01-01 if not provided.

Example: date_from=2025-01-01
date_tostring(date)

End date for filtering (format YYYY-MM-DD). Defaults to today if not provided.

Example: date_to=2025-12-31
client_idstring

Filter by client ID. Accepts a comma-separated list of ids (e.g. 123,456).

Example: client_id=123,456
with_taxesboolean

Include taxes in the report. Defaults to false.

Default false
Example: with_taxes=false
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/reports/balance_per_client?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
balance_per_clientArray of objects(V3BalancePerClientObject)
paginationobject(V3ReportsPagination)
page_totalobject(V3BalancePerClientTotals)
Response
application/json
{ "balance_per_client": [ { … } ], "pagination": { "current_page": 1, "total_pages": 10, "total_count": 100, "per_page": 10 }, "page_total": { "total": 100, "total_paid": 80, "balance": 20 } }

Export Balance Per Client Report

Request

Exports the full balance per client report as an XLSX file, using the same filters as the report endpoint. Results are not paginated — all matching rows are included. Generates the file, uploads it to S3, and returns a presigned download URL valid for about 7 days (X-Amz-Expires=597600).

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
date_fromstring(date)

Start date for filtering (format YYYY-MM-DD). Defaults to 1900-01-01 if not provided.

Example: date_from=2025-01-01
date_tostring(date)

End date for filtering (format YYYY-MM-DD). Defaults to today if not provided.

Example: date_to=2025-12-31
client_idstring

Filter by client ID. Accepts a comma-separated list of ids (e.g. 123,456).

Example: client_id=123,456
with_taxesboolean

Include taxes in amounts. Defaults to false.

Default false
Example: with_taxes=false
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/reports/balance_per_client/export?api_key=YOUR_API_KEY"

Responses

SUCCESS — presigned XLSX download URL

Bodyapplication/json
urlstringrequired

Presigned URL to download the XLSX file. Valid for about 7 days (597600 seconds, X-Amz-Expires=597600).

Example: "https://invoicexpress-downloads.s3.eu-west-1.amazonaws.com/..."
filenamestringrequired

Suggested filename for the download

Example: "balance_per_client_2025-02-23.xlsx"
Response
application/json
{ "url": "https://invoicexpress-downloads.s3.eu-west-1.amazonaws.com/...", "filename": "balance_per_client_2025-02-23.xlsx" }

Get Balance Per Client Report Summary

Request

Returns the aggregate summary of balances per client, using the same filters as the report endpoint.

Security
apiKeyAuth
Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
date_fromstring(date)

Start date for filtering (format YYYY-MM-DD). Defaults to 1900-01-01 if not provided.

Example: date_from=2025-01-01
date_tostring(date)

End date for filtering (format YYYY-MM-DD). Defaults to today if not provided.

Example: date_to=2025-12-31
client_idstring

Filter by client ID. Accepts a comma-separated list of ids (e.g. 123,456).

Example: client_id=123,456
with_taxesboolean

Include taxes in the report. Defaults to false.

Default false
Example: with_taxes=false
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/reports/balance_per_client/summary?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
summaryobject(V3BalancePerClientSummaryObject)
Response
application/json
{ "summary": { "total": 100, "total_paid": 80, "balance": 20 } }

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.