Skip to main content

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_after header 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-V1 header deprecated, use X-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โ€‹

TimelineAction
AnnouncementDeprecation notice in changelog and API response headers
+3 monthsWarning emails to affected users
+6 monthsFeature removed from documentation
+12 monthsFeature disabled (major versions only)

Subscribe to Updatesโ€‹

Stay informed about API changes:

Next Stepsโ€‹