Returns the defaults and choice lists used to build a new document of the specified invoice type (payment terms, exemption reasons, series of that type, currencies, retention options, taxes and default remarks). Nothing is created.
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.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{invoices-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/invoices/new?api_key=YOUR_API_KEY"SUCCESS
Payment-term options in days. The client's (or account's) payment days are flagged selected; a value outside the fixed list replaces the custom entry.
Series of this document type the account can issue in (Portuguese accounts only list series registered with the AT). When there is none, a single placeholder entry is returned with id null, disabled true and serie "Choose a registered Sequence" (or "Choose a Sequence" for foreign accounts).
Withholding-tax options. The first entry (id and value null, "Not applicable") means no retention.
Default observations — the client's (or account's) observations followed by the text of the default exemption reason.
The account's "add Multibanco reference by default" preference. Null unless the plan includes MB, an MB provider is configured and the document type supports a payment reference.
{ "due_date_choices": [ { … }, { … }, { … } ], "exemption_reasons": [ { … } ], "sequences": [ { … } ], "currencies": [ { … } ], "retention": [ { … } ], "remarks": "", "include_payment_reference": null, "has_configured_payment_service": false, "taxes": [ { … } ], "client": { "id": 0, "name": "string", "fiscal_id": "string", "address": "string", "postal_code": "string", "city": "string", "country": "string" } }
Request
Returns an unsaved copy of the document, ready to be edited and sent to create. Nothing is created: id and token are null. The copy is a draft of the path type, dated today, with the due date moved by the client's (or account's) payment days, the exchange rate refreshed for foreign-currency documents, and the account's default series of that type.
The source id can be any document of the account; it is not checked against the path type.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{invoices-type}/{id}/clone
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/invoices/541674/clone?keep_owner_sequence=true&api_key=YOUR_API_KEY"SUCCESS
Wrapper key matches the singular of the requested invoice type (invoice, invoice_receipt, simplified_invoice, credit_note, debit_note, or receipt).
For the receipt wrapper (payment receipts) the shape differs: items are the payments the receipt covers, each {document_type, document_sequence_number, total, paid} (e.g. {"document_type": "Invoice", "document_sequence_number": "2026/12", "total": 123.0, "paid": 123.0}) instead of product lines; account.bank_data and auto_add_related_document are not returned.
{ "invoice": { "id": 264663413, "status": "draft", "cancel_reason": "document was duplicated", "archived": false, "type": "Invoice", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259451, "atcud": "N/A", "saft_hash": "FoIq", "tax_exemption": "M01", "date": "2026-07-27", "due_date": "2026-08-27", "reference": null, "observations": null, "token": "2646634130360dcbca24d2d9509add7c92ccb1d7ab970ce6d", "permalink": "https://web.invoicexpress.com/documents/2646634130360dcbca24d2d9509add7c92ccb1d7ab970ce6d?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, "account": { … }, "client": { … }, "items": [ … ], "summary": { … }, "mb_reference": { … } } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/invoices/{id}/handle_integration
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/invoices/541674/handle_integration?plugin_id=3f2504e0-4f89-11d3-9a0c-0305e82c3301&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.