Create quotes, proformas and fees notes and send them to your clients.
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.
Number of series per page. items_per_page and page_items are accepted as aliases.
Sort field. Any other value sorts by created_at.
Free-text search on the série name. Ignored when its first word has fewer than 3 characters.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/sequences?api_key=YOUR_API_KEY"{ "sequences": [ { … } ], "totals": { "pages": 1, "total": 1 }, "offer_demo_cleanup": false }
When true (or the string "true"), the new série becomes the account's default série.
When true (or the string "true"), the série is also registered with the tax authority (AT) right after it is created. The response is then 202 instead of 201.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/sequences?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"sequence":{"serie_name":"SERIE2026","set_as_default":false,"create_and_registry":false}}'CREATED — the série was created (create_and_registry not set)
Relative path and query string to poll with GET /api/v3/sequences/create_status. Its account_id is an encrypted account token, not the numeric account id — pass it back unchanged.
{ "success": true, "status_endpoint": "/create_status?account_id=7117e09c4cd4ba7b05b2cc10e34d8684&serie_name=SERIE2026&create_and_registry=false&sequence_already_exists=false" }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/by_name
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/sequences/by_name?api_key=YOUR_API_KEY"{ "series": [ "INVOICEXPRESSDEMO", "SERIE2026" ] }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/collection
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/sequences/collection?api_key=YOUR_API_KEY&name=INVOICEXPRESSDEMO"{ "sequences": [ { … } ], "register_status": "", "sequence_status": "active" }
Request
Checks the creation status of a sequence. Called with the query string returned in status_endpoint from the create and register operations. No API key is needed — the encrypted account_id token identifies the account. Returns 202 while the operation is still running and 200 once it has finished; a failed operation is also answered with 200 and success set to false.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/create_status
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/sequences/create_status?account_id=7117e09c4cd4ba7b05b2cc10e34d8684&serie_name=SERIE2026&create_and_registry=false&sequence_already_exists=false"{ "operation_status": "finished", "success": true, "data": {} }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/default
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/sequences/default?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "success": true }
Request
Archives a série, for every document type at once. An archived série is no longer offered when a new document is prepared, and cannot be made the default. It does not block anything else: existing documents are unaffected, and a document can still be created with it through the API. The default série cannot be archived.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/archive
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/sequences/archive?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"sequence":{"serie_name":"SERIE2026"}}'{ "success": true }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/unarchive
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/sequences/unarchive?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"sequence":{"serie_name":"SERIE2026"}}'{ "success": true }
The série is identified by its name, not by a sequence id. All the sequences of that série that still need registering are sent to the AT.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/register
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/sequences/register?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"sequence":{"serie_name":"INVOICEXPRESSDEMO"}}'ACCEPTED — registration started
Relative path and query string to poll with GET /api/v3/sequences/create_status. Its account_id is an encrypted account token, not the numeric account id — pass it back unchanged.
{ "success": true, "status_endpoint": "/create_status?account_id=7117e09c4cd4ba7b05b2cc10e34d8684&serie_name=SERIE2026&create_and_registry=false&sequence_already_exists=false" }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/sequences/registered_series
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/sequences/registered_series?api_key=YOUR_API_KEY"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 as4.0.0of this one.
Social SecurityCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code
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_keyonly, 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.