Versioning

API Changelog

About

Below is a log of changes to the Persona API. Updates that affect only products or features in beta or limited release may not be reflected.

Each change can be described as either a breaking change or an ongoing change.

  • Breaking changes = new API version: When we make any backwards-incompatible changes, we release a new version of the API. In addition to being assigned a new API version, these changes are marked in the changelog with the 💥 symbol. You’re in charge of when you get breaking changes—you get them when you upgrade your API version. Learn how to try out and upgrade to newer API versions.
  • Ongoing changes: Ongoing changes are backwards-compatible, and are added on an ongoing basis. You don’t need to update your API version to get these updates.

Key

🌱 New feature

🍃 Improvement

🔧 Fix

💥 Breaking change

🔒 Security-related

September 30, 2024

Accounts

  • 🌱 Expose fields as an attribute in Accounts endpoints: In the create and update endpoints for Accounts, fields is now exposed as an attribute. Requests with data in the fields attribute will make updates to an Account’s fields.

Documents

  • 🍃 Add Transaction relationship to Documents: Document resources now include the related Transaction resource details, if any, in data.relationships.

Reports

  • 🌱 Add is_recurring attribute to Reports: Report resources now include an attribute is-recurring that indicate whether or not the Report is queued up for another run in the future.