Get audit trail details

Use GET /v3/reports/audit-trail/vendor/{vendorId} to get audit trail details about changes made to a vendor object. The audit trail lists records for each create and edit operation.

See Get audit trail details for a vendor in the API reference for more information.

Sample request

In this cURL example, an audit trail of 5 results is requested for the specified vendorId. includeArchived is set as true to include archived results in the response.

curl --request GET \
--url 'https://gateway.stage.bill.com/connect/v3/reports/audit-trail/vendor/{vendorId}?includeArchived=true&max=5' \
--header 'content-type: application/json' \
--header 'devKey: {developer_key}' \
--header 'sessionId: {session_id}'

Response

In the response, an audit trail of each create and update operation is available for the specified vendor.

[
    {
        "source": "API",
        "type": "Create",
        "createdTime": "{date_time}",
        "user": {
            "id": "{user_id}",
            "name": "Admin Billworth"
        },
        "field": {}
    },
    {
        "source": "API",
        "type": "Edit",
        "createdTime": "{date_time}",
        "user": {
            "id": "{user_id}",
            "name": "Admin Billworth"
        },
        "field": {
            "name": "Pay by",
            "value": {
                "previous": "Check",
                "current": "ePayment"
            }
        }
    }
]