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.
Optional. When sent, the configuration of that client is created/updated instead of the account's. An unknown client returns 404 "Client not found".
An enum field with a value outside its list returns 422.
Account level (no client_id): when true, every client-level configuration is deleted, so all clients follow the account configuration.
Client level (PUT with client_id): when true, the client's own configuration is deleted (the client falls back to the account configuration) and the other fields are ignored; the response is {"collection_alert": {"client_has_email": ...}}.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/collection_alerts
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X POST "https://api-v3.app.invoicexpress.com/api/v3/collection_alerts?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "collection_alert": { "configurable": "Client", "frequency": "biweekly", "weekday": "monday", "period": "morning", "due": "before_overdue", "email": true, "sms": false, "email_template": "This is an email\nwith a break line", "sms_template": null, "client_has_email": true } }
Request
Updates the existing collection alert configuration of the account, or of a client when client_id is sent.
- Account level,
replicate=true: every client-level configuration is deleted, so all clients follow the account configuration. - Client level,
replicate=true: the client's own configuration is deleted (the client falls back to the account configuration), the other fields are ignored, and the response is{"collection_alert": {"client_has_email": true|false}}.
Optional. When sent, the configuration of that client is created/updated instead of the account's. An unknown client returns 404 "Client not found".
An enum field with a value outside its list returns 422.
Account level (no client_id): when true, every client-level configuration is deleted, so all clients follow the account configuration.
Client level (PUT with client_id): when true, the client's own configuration is deleted (the client falls back to the account configuration) and the other fields are ignored; the response is {"collection_alert": {"client_has_email": ...}}.
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/collection_alerts
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X PUT "https://api-v3.app.invoicexpress.com/api/v3/collection_alerts?api_key=YOUR_API_KEY" -H "Content-Type: application/json" --data '{}'{ "collection_alert": { "configurable": "Client", "frequency": "biweekly", "weekday": "monday", "period": "morning", "due": "before_overdue", "email": true, "sms": false, "email_template": "This is an email\nwith a break line", "sms_template": null, "client_has_email": true } }
- Production Serverhttps://api-v3.app.invoicexpress.com/api/v3/collection_alerts
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -X GET "https://api-v3.app.invoicexpress.com/api/v3/collection_alerts?api_key=YOUR_API_KEY"{ "collection_alert": { "configurable": "Client", "frequency": "biweekly", "weekday": "monday", "period": "morning", "due": "before_overdue", "email": true, "sms": false, "email_template": "This is an email\nwith a break line", "sms_template": null, "client_has_email": 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.