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¶

See DisputeNoteV1Response.

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>'

Query Parameters¶

Field	Type	Description
`Visibility`	string	Filter by visibility. Pass as repeated params to include multiple values: `?Visibility=Internal&Visibility=All`
`Sort`	string	Fields to sort by; defaults to `-CreateDate`
`Page`	integer	Page number; defaults to `1`
`PageSize`	integer	Records per page; defaults to `20`

Example Response¶

See Dispute Note List.

Retrieving all Notes for a Tenant¶

Returns all notes across all disputes for a tenant. Useful for syncing or auditing note activity.

Swagger Page¶

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

Permission¶

Dispute Management : READ

Example Request¶

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

Query Parameters¶

Field	Type	Description
`FromDate`	datetime	Return notes with an `updateDate` on or after this date. Inclusive
`ToDate`	datetime	Return notes with an `updateDate` on or before this date. Inclusive
`Sort`	string	Fields to sort by; defaults to `-UpdateDate`. Prepend `-` for descending
`Page`	integer	Page number; defaults to `1`
`PageSize`	integer	Records per page; defaults to `1000`

Example Response¶

See Dispute Note List.

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 '<request body>'

Example Request Body¶

{
  "content": "Spoke with customer, they confirmed the shipment arrived damaged.",
  "visibility": "Internal"
}

Request Fields¶

Field	Type	Required	Description
`content`	string	No	The text content of the note
`visibility`	string	No	The visibility of the note

Example Response¶

See DisputeNoteV1Response.

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 '<request body>'

Example Request Body¶

{
  "content": "Phasellus nec sem in justo pellentesque facilisis.",
  "visibility": "All"
}

Request Fields¶

Field	Type	Required	Description
`content`	string	No	The updated text content of the note
`visibility`	string	No	The visibility of the note

Example Response¶

See DisputeNoteV1Response.

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>'

Appendix¶

DisputeNoteV1Response¶

Returned by single-note endpoints (Get by ID, Create, Update).

{
  "disputeNoteId": "{noteId}",
  "tenantId": "{tenantId}",
  "disputeId": "{disputeId}",
  "content": "Spoke with customer, they confirmed the shipment arrived damaged.",
  "visibility": "Internal",
  "createUser": "{userId}",
  "createDate": "2021-03-28T14:27:48.190Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T14:27:48.190Z"
}

Dispute Note List¶

Returned by list endpoints (Retrieving all Notes for a Dispute, Retrieving all Notes for a Tenant). An array of DisputeNoteV1Responses.

[
  {
    "disputeNoteId": "{noteId}",
    "tenantId": "{tenantId}",
    "disputeId": "{disputeId}",
    "content": "Spoke with customer, they confirmed the shipment arrived damaged.",
    "visibility": "Internal",
    "createUser": "{userId}",
    "createDate": "2021-03-28T14:27:48.190Z",
    "updateUser": "{userId}",
    "updateDate": "2021-03-28T14:27:48.190Z"
  },
  ...
]