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

Send Open Account Link Mail

Request

Sends an open account link email to a chosen client.

Security
apiKeyAuth
Path
idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Bodyapplication/jsonrequired
send_open_account_link_mailobjectrequired
send_open_account_link_mail.​clientobjectrequired

Required. Omitting client fails with HTTP 500.

send_open_account_link_mail.​client.​emailstringrequired

Required (client's email is required).

Example: "john.doe@invoicexpress.com"
send_open_account_link_mail.​client.​saveintegerrequired

Required (client save is required). 1/true stores email as the client's preferred contact email.

Example: 0
send_open_account_link_mail.​ccstring
Example: "john.doe@invoicexpress.com"
send_open_account_link_mail.​bccstring
Example: "john.doe@invoicexpress.com"
send_open_account_link_mail.​notification_typestring
Example: "open_account_link"
send_open_account_link_mail.​send_email_copyinteger
Example: 0
send_open_account_link_mail.​bodystring
Example: "Some email body with a link"
send_open_account_link_mail.​subjectstring
Example: "Something important"
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/clients/1/send_open_account_link_mail?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
successboolean
Example: true
Response
application/json
{ "success": true }

Create Treasury Movement

Request

Creates a new treasury movement for a client.

A Payment settles the client's open documents up to value and issues a receipt for each. A Reimbursement is spread over the client's settled documents (or only document_id when sent).

Send an Idempotency-Key header to make retries safe: a repeated request with the same key and payload replays the first answer instead of creating a second movement.

Security
apiKeyAuth
Path
client_idstringrequired

Client id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
Headers
Idempotency-Keystring

Optional client-generated unique key (e.g. a UUID). Without it, every request creates a new movement.

Example: 6f1c2a4e-1b7d-4c55-9a0e-3f2b8d7c9e10
Bodyapplication/jsonrequired
treasury_movementobjectrequired
treasury_movement.​movement_typestringrequired

Any other value is rejected with HTTP 422.

Enum"Payment""Reimbursement""InitialBalance""Regularization"
Example: "Payment"
treasury_movement.​valuenumber>= 0

For Payment, must not exceed the client's open balance (with VAT). For Reimbursement, must not exceed the settled balance that can be reimbursed (of document_id when sent, otherwise of all the client's documents).

Example: 123.45
treasury_movement.​datestring(date)required

Required — omitting it fails with HTTP 500. A value that cannot be parsed as a date is replaced by today's date.

Example: "2023-04-28"
treasury_movement.​payment_methodstring
Example: "MB"
treasury_movement.​document_idinteger

Reimbursement only: restrict the reimbursement to this settled document.

Example: 987654
treasury_movement.​seriestring

Payment only: passed to the receipts issued for the paid documents. Not stored on the movement.

Example: "2023"
treasury_movement.​observationstring or null

Payment only: used as the note of the receipts issued for the paid documents. Not stored on the movement.

Example: null
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/clients/12345/treasury_movements?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'

Responses

SUCCESS

Bodyapplication/json
treasury_movementobject(V3TreasuryMovementObject)
Response
application/json
{ "treasury_movement": { "id": 123456, "value": 123.45, "movement_type": "Reimbursement", "payment_method": "MB", "date": "2023-04-28" } }

Delete Treasury Movement

Request

Cancels a treasury movement of the client (soft cancel; the movement is marked as canceled, not removed). When the movement has child movements, every child is canceled too.

Security
apiKeyAuth
Path
client_idstringrequired

Client id

idstringrequired

Treasury movement id

Query
api_keystringrequired

Your API Key.

Example: api_key=YOUR_API_KEY
curl -X DELETE "https://api-v3.app.invoicexpress.com/api/v3/clients/12345/treasury_movements/1?api_key=YOUR_API_KEY"

Responses

SUCCESS

Response
No content

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.