Returns a transformed version of the specified invoice document. This is typically used to prepare the document to be converted into another invoice-type document (e.g., credit note or other variations), mirroring the data structure of a cloned document ready for further edits.
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/{id}/transform_document
- 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/transform_document?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-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/invoices/541674?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": { … } } }
Request
Updates a document of the specified invoice type and returns it. The id must belong to a document of that type. The request body wrapper key must be the singular of the path segment (invoice, invoice_receipt, simplified_invoice, credit_note, debit_note). The body accepts the same fields as create, and items must again contain at least one item: the item list sent replaces the stored one.
Documents in status sent, settled, deleted, canceled, accepted, refused or second_copy cannot be changed (422 "Document has been finalized so can't be changed anymore").
The type of the invoice document.
Your own idempotency identifier for the document. Accepted here at the top level or inside the wrapper; a repeated value returns the document already created with it instead of creating a new one.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/{invoices-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/invoices/541674?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{"invoice":{"date":"2026-07-27","due_date":"2026-08-27","client":{"id":456},"items":[{"name":"Product Name","unit_price":100,"quantity":1}]}}'{ "invoice": { "id": 541674, "status": "final", "cancel_reason": "document was duplicated", "archived": false, "type": "Invoice", "sequence_number": "2024/001", "inverted_sequence_number": "001/2024", "sequence_id": 123, "owner_invoice_id": 541673, "atcud": "ATCUD123456", "saft_hash": "1234", "tax_exemption": "M01", "date": "2024-01-15", "due_date": "2024-02-15", "reference": "REF001", "observations": "Payment terms: 30 days", "token": "541674bbfcdd182143fe2747524df08ab1367ef8255010", "permalink": "https://web.invoicexpress.com/documents/541674bbfcdd182143fe2747524df08ab1367ef8255010?language=pt", "retention": 0, "global_discount": 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": { … } } }
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.