API Changelog
Track API updates, new features, and breaking changes.
Versioning Policyโ
GoRoute uses semantic versioning for API changes:
- Major versions (v1 โ v2): Breaking changes, announced 6+ months in advance
- Minor versions: New features, backward compatible
- Patch versions: Bug fixes, no API changes
The current API version is v1.
2024โ
v1.8.0 โ 2024-02-01โ
New Features
- โจ Batch validation endpoint โ Validate multiple documents in one call
POST /api/v1/batch/validate - โจ Singapore InvoiceNow support โ Full support for scheme 0195 (UEN)
- โจ Attachment preview โ Get thumbnail previews of PDF attachments
Improvements
- ๐ Improved SMP lookup performance (50% faster)
- ๐ Better error messages for XRechnung validation
- ๐ Added
retry_afterheader on rate limit responses
Bug Fixes
- ๐ Fixed currency rounding for JPY invoices
- ๐ Fixed webhook retry timing calculation
v1.7.0 โ 2024-01-15โ
New Features
- โจ Partner verification API โ Verify trading partner capabilities
GET /api/v1/participants/{id}/verify - โจ Webhook signature v2 โ More secure HMAC-SHA256 signatures
- โจ Transaction export โ Export transaction history as CSV
Improvements
- ๐ Added France Factur-X format support
- ๐ Improved Italian SDI integration reliability
- ๐ Extended transaction history retention to 7 years
Deprecations
- โ ๏ธ
X-Webhook-Signature-V1header deprecated, useX-Webhook-Signature
v1.6.0 โ 2024-01-01โ
New Features
- โจ XRechnung 3.0 support โ Latest German CIUS version
- โจ Async batch sending โ Non-blocking batch operations
POST /api/v1/batch?async=true - โจ Document search โ Search received documents by metadata
Improvements
- ๐ Updated Peppol BIS to 2024 release
- ๐ Added Belgium scheme 0208 validation
- ๐ Reduced validation latency by 30%
2023โ
v1.5.0 โ 2023-10-01โ
New Features
- โจ Invoice Response (MLR) โ Send and receive invoice responses
- โจ Participant migration API โ Bulk migrate from other Access Points
- โจ Rate limit headers โ
X-RateLimit-Remaining,X-RateLimit-Reset
Improvements
- ๐ Added Norwegian EHF 3.0 support
- ๐ Improved webhook delivery reliability
Breaking Changes
- โ ๏ธ None
v1.4.0 โ 2023-07-01โ
New Features
- โจ Credit Note API โ Dedicated endpoint for credit notes
- โจ Attachment support โ Embed PDF attachments in invoices
- โจ Webhook filtering โ Subscribe to specific event types
Improvements
- ๐ Added Netherlands scheme 0106 (KVK) validation
- ๐ Better handling of large documents (up to 100MB)
v1.3.0 โ 2023-04-01โ
New Features
- โจ Sandbox environment โ Test without affecting production
- โจ Participant lookup cache โ Cached SMP responses
- โจ Transaction tracking โ Real-time delivery status
Improvements
- ๐ Reduced send latency by 40%
- ๐ Added support for 15 new identifier schemes
v1.2.0 โ 2023-01-15โ
New Features
- โจ Webhooks โ Real-time event notifications
- โจ Bulk registration โ Register multiple participants at once
- โจ API key scopes โ Granular permissions
Improvements
- ๐ Enhanced validation error messages
- ๐ Added idempotency key support
2022โ
v1.1.0 โ 2022-10-01โ
New Features
- โจ Validation API โ Pre-flight document validation
- โจ Document types โ Order, Order Response support
- โจ Multi-organization โ Single API key, multiple organizations
Improvements
- ๐ Improved uptime to 99.99%
- ๐ Added detailed API documentation
v1.0.0 โ 2022-06-01โ
Initial Release ๐
- Invoice and Credit Note sending via Peppol
- Participant registration on Peppol SMP
- Basic webhook notifications
- REST API with JSON responses
- Python and JavaScript SDKs
Upcoming Changesโ
v1.9.0 โ Planned Q2 2024โ
- ๐ฎ E-Ordering โ Full ordering workflow support
- ๐ฎ AI validation โ Machine learning for invoice validation
- ๐ฎ GraphQL API โ Alternative to REST for complex queries
- ๐ฎ Real-time streaming โ WebSocket for live updates
v2.0.0 โ Planned Q4 2024โ
Major version upgrade with:
- Simplified API structure
- Enhanced security model
- Expanded country support
Migration Path: Documentation and tools will be provided 6 months before v2 release.
Deprecation Policyโ
| Timeline | Action |
|---|---|
| Announcement | Deprecation notice in changelog and API response headers |
| +3 months | Warning emails to affected users |
| +6 months | Feature removed from documentation |
| +12 months | Feature disabled (major versions only) |
Subscribe to Updatesโ
Stay informed about API changes:
- ๐ง Email: Subscribe to developer newsletter in dashboard
- ๐ก RSS: docs.goroute.ai/changelog.rss
- ๐ Dashboard: app.goroute.ai