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.
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.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v1/edi/{id}/cius-pt
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v1/edi/541674/cius-pt?api_key=YOUR_API_KEY"{ "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" }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v1/edi/{id}/additional_fields
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v1/edi/541674/additional_fields?api_key=YOUR_API_KEY"{ "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" } }
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.
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.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v1/edi/{id}/additional_fields
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"}}'{ "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" } }
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.