Guide

Versioning & changes

The version is in the path. Within a version we only add; when we must break, you get a new version and time to move.

Versions

Every path starts with the major version — today /v1. The OpenAPI document reports the exact release in info.version (currently 1.0.0).

Changes we make without a new version

Build clients that tolerate these:

• New endpoints, and new optional query parameters or body fields.
• New fields in responses. Ignore what you do not recognise.
• New values in enumerations such as status or type. Treat an unknown value as "other" rather than failing.
• Changes to human-readable message text, and to the encoding of cursors.
• Higher rate limits or larger page-size maximums.

Breaking changes

Removing or renaming a field or endpoint, changing a field's type or meaning, tightening validation, or removing an enumeration value is breaking. We ship those only in a new major version, keep the previous version running for at least 12 months after the new one is announced, and say so here and by email to the addresses of the workspace owners whose keys still call the old version.

Changelog

1.0.0 — initial release

• Workspace API keys with scopes and expiry.
• Read access to companies, accounts, transactions, categories and bills; full read/write access to payees.
• Cursor pagination and updatedAfter for incremental sync.

On the roadmap

• Outbound webhooks for transaction, bill and payment events.
• Uploading bills (invoice documents) through the API.
• Initiating transfers, subject to the same approval rules and bank consent as in the app.