Dispute Audit Logs¶

Retrieving a Dispute's Activity Log¶

Returns the full audit trail for a dispute, including note events.

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeAuditV1/get_v1_tenants__tenantId__disputes__disputeId__activity_log

Permission¶

Dispute Management : READ

Example Request¶

curl -X GET 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/disputes/{disputeId}/activity-log' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response¶

See Dispute Audit Log.

Retrieving a Dispute's Audit Log¶

Returns the audit trail for a dispute, excluding note events. Use this when you only need to see changes to the dispute itself (status, assignee, amount, etc.).

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeAuditV1/get_v1_tenants__tenantId__disputes__disputeId__audit_log

Permission¶

Dispute Management : READ

Example Request¶

curl -X GET 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/disputes/{disputeId}/audit-log' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response¶

See Dispute Audit Log.

Appendix¶

Dispute Audit Log¶

Returned by both audit endpoints. An array of audit entries, each with a list of changes.

[
  {
    "tenantId": "{tenantId}",
    "disputeId": "{disputeId}",
    "userId": "{userId}",
    "timeStamp": "2021-03-28T15:20:33.165Z",
    "changes": [
      {
        "action": "AssigneeChange",
        "from": "Steve Rogers",
        "to": "Tony Stark"
      },
      {
        "action": "AmountChange",
        "from": "100.50",
        "to": "80.50"
      }
    ]
  },
  ...
]

Change Actions¶

Value	Description
`Unknown`	Unknown change, should not occur
`AssigneeChange`	Assignee changed
`DepartmentChange`	Department changed
`AmountChange`	Amount changed
`ReasonChange`	Reason changed
`CategoryChange`	Category changed
`Note`	Note added
`AttachmentAdded`	Attachment added
`AttachmentDeleted`	Attachment deleted
`StatusChange`	Status changed
`ExternalReasonChange`	External reason changed