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
Returns the defaults and choices needed to build a new estimate of the given type (due-date options, exemption reasons, issuable sequences, currencies, retention options, default remarks, taxes). Nothing is created. When client_id is sent, the client's payment days, exemption code, currency and observations take priority over the account's.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{estimate_type}/new
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/quotes/new?api_key=YOUR_API_KEY"SUCCESS
Due-date options in days. The one matching the client's (or else the account's) payment days is flagged selected; a value not in the list replaces the last ("Other") entry.
VAT exemption reasons; the client's (or account's) code is flagged selected.
Sequences of this estimate type available for issuing (only AT-registered ones for Portuguese accounts). The account's current serie is flagged selected. When there are none, a single disabled placeholder entry with id null is returned ("Choose a registered Sequence", or "Choose a Sequence" for foreign accounts).
Withholding-tax options. The first entry ("Not applicable") has id and value null.
Default observations (client's, else account's) followed by the exemption reason text, if any.
Null unless the plan has MB references, a payment provider is configured and the type supports payment references; then the account's estimate setting.
{ "due_date_choices": [ { … }, { … }, { … }, { … } ], "exemption_reasons": [ { … } ], "sequences": [ { … } ], "currencies": [ { … } ], "retention": [ { … } ], "remarks": "string", "include_payment_reference": true, "has_configured_payment_service": false, "auto_send_invoice_from_estimate": false, "taxes": [ { … } ], "client": { "id": 0, "name": "string", "fiscal_id": "string", "address": "string", "postal_code": "string", "city": "string", "country": "string" } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{estimate_type}/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/quotes/541674?api_key=YOUR_API_KEY"{ "quote": { "id": 257118662, "status": "draft", "archived": false, "type": "Quote", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259462, "atcud": "N/A", "date": "2026-05-11", "due_date": "2026-06-11", "reference": null, "observations": null, "token": "2571186625ad1072ab31349f6c7c6bd919c2547e43c965aa1", "permalink": "https://web.invoicexpress.com/documents/2571186625ad1072ab31349f6c7c6bd919c2547e43c965aa1?language=pt", "retention": 0, "global_discount": null, "owner_invoice_id": null, "raw_owner_invoice": "FT 2026/253", "currency": null, "auto_add_related_document": false, "qr_code": "https://example.com/qr_codes/264663413.png", "digital_signed": false, "include_payment_reference": false, "auto_send_invoice_from_estimate": false, "account": { … }, "client": { … }, "items": [ … ], "summary": { … } } }
Request
Updates an estimate of the given type. The wrapper key must be the singular of the path type (quote, proforma, fees_note). items is required and replaces the whole item set. Documents in state sent, settled, deleted, canceled, accepted, refused or second_copy cannot be edited.
Optional on update. When sent, it must identify a client by id, name or code; an id not owned by the account (with no name/code to fall back on) returns 422 "No client was found with the id provided."
Maximum 60 characters. Longer values are rejected with 422 ("Code for the item is too long").
Maximum 200 characters and at most 20 lines. Longer values are rejected with 422.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{estimate_type}/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/quotes/541674?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"quote":{"date":"2026-05-11","due_date":"2026-06-11","items":[{"name":"Service A","unit_price":100,"quantity":1,"tax":{"name":"IVA23"}}]}}'{ "quote": { "id": 257118662, "status": "draft", "archived": false, "type": "Quote", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259462, "atcud": "N/A", "date": "2026-05-11", "due_date": "2026-06-11", "reference": null, "observations": null, "token": "2571186625ad1072ab31349f6c7c6bd919c2547e43c965aa1", "permalink": "https://web.invoicexpress.com/documents/2571186625ad1072ab31349f6c7c6bd919c2547e43c965aa1?language=pt", "retention": 0, "global_discount": null, "owner_invoice_id": null, "raw_owner_invoice": "FT 2026/253", "currency": null, "auto_add_related_document": false, "qr_code": "https://example.com/qr_codes/264663413.png", "digital_signed": false, "include_payment_reference": false, "auto_send_invoice_from_estimate": false, "account": { … }, "client": { … }, "items": [ … ], "summary": { … } } }
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.