How may we help?

Introduction

A ChangeLog represents a change in an entity, such that the changes are transparent and traceable over time. A single ChangeLog entity can be used to reason what, why, when and by whom an entity was changed.

ChangeLog types

ChangeLogs can be of the following types:

• Contact
• Subscription
• Agreement
• AddOn

Endpoints

For each entity type that supports logging changes there exist an endpoint for which the ChangeLogs of a specific entity can be retrieved.

By specifiying the query parameter “limit” it can be controlled how many ChangeLogs to retrieve. Default is no limit. ChangeLogs are returned sorted with the most recent first.

Response

HTTP 200 Example

[
    {
        "changeGuid": "16b48073-xxxx-xxxx-xxxx-0a337c4ba4dc",
        "createdTs": "2021-04-23 10:26:07 +0200",
        "entityType": "Subscription",
        "entityGuid": "1222ac4a-xxxx-xxxx-xxxx-bb9df2b9ab53",
        "changeTs": "2021-04-23 10:26:07 +0200",
        "oldEntityJson": "{\"subscriptionGuid\":\"1222ac4a-xxxx-xxxx-xxxx-bb9df2b9ab53\",\"merchantId\":\"your-ngo\", ...}",
        "changeDescription": "Cancel subscription",
        "changeMetaData": "{}",
        "requester": "individual@your-ngo.org",
        "systemRequest": false,
        "changes": [
            {
                "newValue": 100102,
                "fieldName": "cancelCode"
            },
            {
                "newValue": "anden årsag",
                "fieldName": "cancelDescription"
            },
            {
                "newValue": "2021-04-23 10:26:06 +0200",
                "fieldName": "cancelledTs"
            },
            {
                "newValue": "2021-04-23 10:26:06 +0200",
                "fieldName": "inactivatedTs"
            },
            {
                "newValue": "Inactive",
                "oldValue": "Active",
                "fieldName": "state"
            }
        ],
        "keysOnly": false,
        "requesterIp": "18.195.xx.xxx"
    }
]

Properties