Dispute Notes¶

Retrieving a Note by ID¶

Swagger Page¶

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

Permission¶

Dispute Management : READ

Example Request¶

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

Example Response¶

{
  "disputeNoteId": "{noteId}",
  "tenantId": "{tenantId}",
  "disputeId": "{disputeId}",
  "content": "Etiam ut purus mattis mauris sodales aliquam. Aliquam lobortis.",
  "visibility": "Internal",
  "createUser": "{userId}",
  "createDate": "2021-03-28T14:27:48.190Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T14:27:48.190Z"
}

Retrieving all Notes for a Dispute¶

Swagger Page¶

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

Permission¶

Dispute Management : READ

Example Request¶

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

Example Response¶

[
  {
    "disputeNoteId": "{noteId}",
    "tenantId": "{tenantId}",
    "disputeId": "{disputeId}",
    "content": "Etiam ut purus mattis mauris sodales aliquam. Aliquam lobortis.",
    "visibility": "Internal",
    "createUser": "{userId}",
    "createDate": "2021-03-28T14:27:48.190Z",
    "updateUser": "{userId}",
    "updateDate": "2021-03-28T14:27:48.190Z"
  },
    ...
]

Creating a Note¶

Swagger Page¶

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

Permission¶

Dispute Management : UPDATE

Example Request¶

curl -X POST 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/disputes/{disputeId}/disputenotes' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "content": "Etiam ut purus mattis mauris sodales aliquam. Aliquam lobortis.", "visibility" : "Internal" | "All" }'

Example Response¶

{
  "disputeNoteId": "{noteId}",
  "tenantId": "{tenantId}",
  "disputeId": "{disputeId}",
  "content": "Etiam ut purus mattis mauris sodales aliquam. Aliquam lobortis.",
  "visibility": "Internal",
  "createUser": "{userId}",
  "createDate": "2021-03-28T14:27:48.190Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T14:27:48.190Z"
}

Updating a Note¶

Swagger Page¶

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

Permission¶

Dispute Management : UPDATE

Example Request¶

curl -X PUT 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/disputes/{disputeId}/disputenotes/{noteId}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "content": "Phasellus nec sem in justo pellentesque facilisis.", "visibility": "All" }'

Example Response¶

{
  "disputeNoteId": "{noteId}",
  "tenantId": "{tenantId}",
  "disputeId": "{disputeId}",
  "content": "Phasellus nec sem in justo pellentesque facilisis.",
  "visibility": "All",
  "createUser": "{userId}",
  "createDate": "2021-03-28T14:27:48.190Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-30T09:44:00.000Z"
}

Deleting a Note¶

Swagger Page¶

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

Permission¶

Dispute Management : DELETE

Example Request¶

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