Skip to content
Fakturnaut
Sign up free

Versioning and deprecation

The API is versioned in the path: https://fakturnaut.com/v1. Within v1 we only make compatible changes, without notice:

  • new endpoints, new optional request fields, new response fields, new enum values, new error codes, new webhook event types and new fields in event data;
  • clearer error messages (detail), never changed codes.

Write clients that ignore unknown fields and handle unknown enum values and codes.

Breaking changes

Removing or renaming fields, changing types or meaning, or making optional fields required only happens in a new major version (v2). Then:

  • v1 keeps working for at least 12 months after v2 is available;
  • deprecated endpoints answer with Deprecation and Sunset headers and a Link to the migration guide;
  • we announce it by e-mail to every account and in the changelog.

Security fixes may change behaviour at short notice when there is no other way; we document them in the changelog.

The SDKs (being published) follow semantic versioning and are generated from the published API description, so they change with it.