The type of the invoice 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
Creates a new document of the specified invoice type, as a draft unless finalized later through change-state. The request body wrapper key must be the singular of the path segment:
invoiceforinvoicesinvoice_receiptforinvoice_receiptssimplified_invoiceforsimplified_invoicescredit_noteforcredit_notesdebit_notefordebit_notes
Any other key returns 422 No <element> element provided. The response wrapper key follows the same rule.
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}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/invoices?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "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": { … } } }
Request
Returns all document batches belonging to the authenticated account. Each item includes the stored number_of_documents value as count (set when the import batch is finalized). Use each batch id as the batch_id query parameter on GET /api/v3/invoices to list only invoices from that batch.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/invoices/batches
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/invoices/batches?api_key=YOUR_API_KEY"{ "document_batches": [ { … } ] }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/invoices/{id}/check_finalize
- 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/check_finalize?api_key=YOUR_API_KEY"{ "document_future_date": true, "has_earlier_draft": true }
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.