History events

Retrieve a single history event

You can retrieve a single history event by using the history-events endpoint in the common API. To use this endpoint you must first retrieve the historyEventId from the history-events endpoint on the relevant object, such as the contacts object in the ContactManager Contact API. (For more information on the Contact API, see ContactManager Cloud API Consumer Guide for ContactManager.)

The information retrieved in this example is from an account change history event where the account changed from pending to active.

Command

GET /common/v1/history-events/S-d_RRz9cG9bhqcfVN2xC

Response

{
    "data": {
        "attributes": {
            "account": {
                "displayName": "C000478975",
                "id": "SaDgS3XDMmUlTYlw-HNoI",
                "type": "Account",
                "uri": "/account/v1/accounts/SaDgS3XDMmUlTYlw-HNoI"
            },
            "customType": {
                "code": "acct_changed",
                "name": "Account changed"
            },
            "description": "Pending account became active",
            "eventTimestamp": "2024-06-03T23:03:05.992Z",
            "historyType": {
                "code": "custom",
                "name": "Custom"
            },
            "id": "SJj0sm_oXm7aZUXrKuWxF",
            "user": {
                "displayName": "Super User",
                "id": "default_data:1",
                "type": "User",
                "uri": "/admin/v1/users/default_data:1"
            }
        },
    …
}

Retrieve account history events

Account history events include changes to the account itself and financial transactions related to the account and any policies it owns.

Command

GET /billing/v1/accounts/pc:632/history-events

Response

{
    "count": 5,
    "data": [
        {
            "attributes": {
                "description": "Account Created",
                "eventDate": "2024-11-18T19:41:53.678Z",
                "id": "bc:SMu-oWMYmtGYGLpNC_ctW",
                "user": {
                    "displayName": "Super User",
                    "id": "default_data:1",
                    "type": "User",
                    "uri": "/admin/v1/users/default_data:1"
                }
            },
            ...
        },
        ...
    ],
    ...
}

Retrieve policy period history events

Policy period history events relate to the policy period iand financial transactions related to the policy period. For example, when a policy period enters the delinquency phase, a dunning letter is sent, which is recorded as a history event.

Command

GET /billing/v1/accounts/pc:234/policies/bc:242/policy-periods/bc:345/history-events

Response

{
    "count": 5,
    "data": [
        {
            "attributes": {
                "description": "Dunning Letter Sent",
                "eventDate": "2025-03-18T20:28:58.755Z",
                "id": "bc:Sc5bdAEz5TAWX2zhIHQj4",
                "user": {
                    "displayName": "System User",
                    "id": "systemTables:2",
                    "type": "User",
                    "uri": "/admin/v1/users/systemTables:2"
                }
            },
            ...
        },
        ...
    ],
    ...
}

Retrieve producer history events

Producer history events are used to track financial events related to a producer, as well as other actions.

Command

GET /billing/v1/producers/pc:543/history-events

Response

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "description": "Trouble ticket opened",
                "eventDate": "2025-03-18T20:28:58.755Z",
                "id": "bc:Sc5bdAEz4543253543gefe43f",
                "user": {
                    "displayName": "System User",
                    "id": "systemTables:2",
                    "type": "User",
                    "uri": "/admin/v1/users/systemTables:2"
                }
            },
            ...
        }
        ...
    ]
}