The type of the guide document.
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
Updates a guide of the specified type. The wrapper key must match the path segment (shipping, transport or devolution).
The same rules as on create apply: loaded_at (not in the past) and at least one item are required, and Portuguese accounts must send complete address_from and address_to. The item list replaces the existing items. Guides that are sent, settled, deleted, canceled or second copies can no longer be edited.
Your own idempotency identifier for the document (create only). Accepted here at the top level or inside the wrapper; a repeated value returns the guide already created with it instead of creating a new one.
Load date and time. Required, and must not be in the past; otherwise the API returns 422 Load date must be on or after <current date and time>.
Structured address. Used only by Portuguese accounts, where it is required with all four fields filled in; foreign accounts ignore it and use load_site / delivery_site instead.
Structured address. Used only by Portuguese accounts, where it is required with all four fields filled in; foreign accounts ignore it and use load_site / delivery_site instead.
No enforced length limit; stored as a text column.
Id of the sequence (series) to issue the guide in. The account's default sequence is used when omitted.
Withholding tax rate (percentage). Only applied when it matches an active retention base.
Document-level discount. Send null to remove an existing discount.
Only applied when the account's plan includes multi-currency.
Resolved by id first, then by name / code; a client that does not exist is created.
At least one item is required.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{guides-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/transports/263315060?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"transport":{"loaded_at":"2026-07-13 13:07:00","address_from":{"detail":"123 Loading Street","city":"Lisbon","postal_code":"1000-001","country":"Portugal"},"address_to":{"detail":"456 Client Street","city":"Porto","postal_code":"4000-001","country":"Portugal"},"items":[{"name":"Product Name","unit_price":100,"quantity":1,"tax":{"name":"IVA23"}}]}}'{ "transport": { "id": 263315060, "status": "draft", "archived": false, "type": "Transport", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259467, "atcud": "N/A", "saft_hash": "vaDf", "tax_exemption": "M01", "date": "2026-07-13", "due_date": "2026-07-13", "reference": null, "observations": null, "token": "263315060c9d7840b5909668386f4a9c93d4b3c4b98ab064e", "permalink": "https://web.invoicexpress.com/documents/263315060c9d7840b5909668386f4a9c93d4b3c4b98ab064e?language=pt", "retention": 0, "global_discount": null, "loaded_at": "2026-07-13 13:07:00", "license_plate": null, "at_doc_code_id": null, "address_from": { … }, "address_to": { … }, "load_site": "123 Loading Street, Lisbon", "delivery_site": "456 Delivery Street, Porto", "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": { … } } }
Request
Returns a new, unsaved draft guide of the specified type pre-filled from an existing document — nothing is created. The clone gets today's date, loaded_at 5 minutes from now, the account's default sequence for the type and, for Portuguese accounts, copies of the source addresses. Submit it with POST /api/v3/{guides-type} to create it. Unsaved fields such as id are null.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{guides-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/transports/263315060/clone?api_key=YOUR_API_KEY"{ "transport": { "id": 263315060, "status": "draft", "archived": false, "type": "Transport", "sequence_number": "draft", "inverted_sequence_number": "draft", "sequence_id": 5259467, "atcud": "N/A", "saft_hash": "vaDf", "tax_exemption": "M01", "date": "2026-07-13", "due_date": "2026-07-13", "reference": null, "observations": null, "token": "263315060c9d7840b5909668386f4a9c93d4b3c4b98ab064e", "permalink": "https://web.invoicexpress.com/documents/263315060c9d7840b5909668386f4a9c93d4b3c4b98ab064e?language=pt", "retention": 0, "global_discount": null, "loaded_at": "2026-07-13 13:07:00", "license_plate": null, "at_doc_code_id": null, "address_from": { … }, "address_to": { … }, "load_site": "123 Loading Street, Lisbon", "delivery_site": "456 Delivery Street, Porto", "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": { … } } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{guides-type}/{id}/movements
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/transports/263315060/movements?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.