Changelog
Changes to the public API that callers need to know about.
Envelope change on four foundation routes
The four routes that existed first — ping, device status, companies and trial balance — moved to the standard envelope. This broke callers written against their earlier shape. No external consumer existed when the change was made; their data is unchanged.
| Before | Since | |
|---|---|---|
| Success | { success, data, meta { requestId } } | { success, data, metadata { apiVersion, operation?, requestId } } |
| Error | { success: false, code, message, fieldErrors?, retryable?, data? } | { success: false, data: null, metadata { error { code, message, fieldErrors?, retryable?, details? }, requestId, apiVersion } } |
| Unknown version | data.supportedVersions | metadata.error.details.supportedVersions |