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

Update Client Initial Balance

Request

Updates the initial balance for a client.

Security
apiKeyAuth
Path
idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
initial_balanceobjectrequired
initial_balance.​valuenumber>= 0required

Must be >= 0 and >= the sum of the client's regularizations. Omitting it fails with HTTP 500.

Example: 123
initial_balance.​datestring(date)required

Must be on or before the date of the client's first regularization and on or before the date of the client's first non-draft document.

Example: "2024-01-01"
initial_balance.​observationstring or null
Example: null
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/clients/1/initial_balance?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
initial_balanceobject(V3InitialBalanceObject)
Response
application/json
{ "initial_balance": { "value": 123, "date": "2024-01-01", "observation": null } }

List Client Regularizations

Request

Returns the client's regularizations, paginated.

Security
apiKeyAuth
Path
client_idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
pageinteger>= 1

Page number, starting at 1.

Default 1
Example: page=1
per_pageinteger>= 1

Number of entries per page. items_per_page and page_items are accepted as aliases.

Default 10
Example: per_page=10
sortstring

Column to sort by.

Default "treasury_movements.date"
Value"treasury_movements.date"
Example: sort=treasury_movements.date
sort_orderstring

Sort direction.

Default "ASC"
Enum"ASC""DESC"
Example: sort_order=DESC
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/clients/12345/regularization?api_key=YOUR_API_KEY"

Responses

SUCCESS

Bodyapplication/json
regularizationArray of objects(V3RegularizationItem)
paginationobject
Response
application/json
{ "regularization": [ { … } ], "pagination": { "total_entries": 0, "current_page": 1, "total_pages": 0, "per_page": 10 } }

Create Client Regularization

Request

Creates a new regularization for a client.

Security
apiKeyAuth
Path
client_idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
regularizationobjectrequired
regularization.​valuenumber

Must be less than or equal to the client's remaining balance (initial balance minus existing regularizations).

Example: 123.45
regularization.​datestring(date)required

Required. Cannot be before the date of the client's initial balance.

Example: "2023-08-24"
regularization.​observationstring or null
Example: null
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/clients/12345/regularization?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
regularizationobject(V3RegularizationItem)
Response
application/json
{ "regularization": { "id": 97676682, "number": "NR00012345", "value": 123.45, "date": "2023-08-24", "observation": 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.