Skip to main content
Version: 🚧 Next

Release Notes

This version is available as of platform version v19.0.

Executive summary​

Transaction of a dossier​

A dossier can now carry a transaction object holding the amount, the currency and the metadata of the dossier's transaction. It can be set when creating or updating a dossier, and it is returned on a GET when the new TRANSACTION value is requested in includes. Both directions require the TRANSACTION module to be activated for the FSP.

The object can be sent partially, following the same rules as the other dossier fields: an amount or currency that is not part of the payload keeps its stored value, while sending it as null clears it. Metadata values are merged into what is already stored, so keys that are not sent keep their value.

Summary snapshots of a dossier​

The dossier GET can return the summary snapshots taken of the dossier, most recent first, when the new DOSSIER_SUMMARY_SNAPSHOTS value is requested in includes (it is also part of expanded=true). The include requires the DOSSIER_SUMMARY module to be activated for the FSP and is not part of the default includes.

Each snapshot is returned as a summarySnapshots entry with its idSnapshot, timeCreated, takenBy and a pdfs map holding a signed link (contentURL, limited in time like every other document link) and the filename of each stored PDF render, keyed by the 2-letter ISO code of the language of the render. Only the renders that are stored are listed, so the map may hold fewer languages than the white label supports, or be empty for snapshots taken before the renders existed. The field is read-only.

Task metadata​

The tasks of a dossier can now carry a metadata object holding the metadata fields of the task. It can be set when creating or updating a dossier, and it is returned on a GET when TASKS is requested in includes. Both directions require the TASKS module to be activated for the FSP.

Metadata values are merged into what is already stored, so keys that are not sent keep their value.

Migration guide​

  • Not applicable. All changes are backward compatible.