KPMG Origins has a comprehensive suite of public API that can be used by clients for system-to-system integration: Integrating with Origins | KPMG Origins Help Centre
The KPMG Origins API supports API versioning, allowing the platform to evolve continuously while providing clients with a clear and predictable path for migrating to the latest API version.
Terminology
API versions
current - a fully supported up-to-date version of the API with the most recent features and improvements
deprecated - a fully supported version of the API with a specified end-of-life date
breaking change - a change in the API contract (path, request, response etc) or behaviour that may result in existing clients of the API to break
Support of deprecated versions
A version of the API becomes deprecated from the moment a new version of the API is released.
A new API version is introduced only if it contains breaking changes.
Deprecated versions of the API are supported for at least 3 months from the day of the release of the next version.
For example:
Given v1 was released on 1 Jan 2024, when v2 is released on 1 March 2024, existing clients of the v1 have at least 3 months (until at least 2 June 2024) to upgrade to v2.
Upgrading to latest version
KPMG Origins API uses path-based versioning where the version number is part the API base URL e.g. https://app.kpmgorigins.com/client-api/v3/<some-path>
Here are some indicative steps explaining how a version upgrade may happen:
Navigate to the API documentation page specific to the API you are using e.g. for Movements Production API documentation: https://app.kpmgorigins.com/client-api/swagger/index.htm
The current version will appear at the top right corner of the API documentation page e.g.
Check if the version you are currently using is different from the latest version (v3 in the example above)
If the version you are currently using is lower than the latest version of the KPMG Origins API, you may need to understand the breaking changes first.
For that, navigate and read details of the breaking changes on the API documentation page (and possibly previous versions too, depending if you are more than one version behind):
NB: the API documentation pages are versioned too, the breaking changes documented are relative to the previous version of the API
Once you understand the breaking changes (and as required, updated your integration logic), change the based URL of the KPMG Origins API used in your integration logic by updating the version number.
For example:
Given you are currently using v2 with base URL https://app.kpmgorigins.com/client-api/v2/ that became deprecated, to update to the latest version v3, update the based URL to https://app.kpmgorigins.com/client-api/v3/
To make make the process smoother, please consider using Sandbox environment to test the upgrade before applying it to your production system. You can find the Sandbox URLs here: Integrating with Origins | KPMG Origins Help Centre