Dispute Resolutions¶

Retrieving a Resolution¶

This endpoint can be used to return a single resolution by its external code.

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Example Response¶

{
  "resolutionId": "{resolutionId}",
  "tenantId": "{tenantId}",
  "code": "DISPVALID",
  "description": "Dispute Validated",
  "active": true,
  "isValid": true,
  "applyWhenInvoiceClosed": false,
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T15:30:21.242Z"
}

Retrieving a List of Resolutions¶

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Example Response¶

[
    {
      "resolutionId": "{resolutionId}",
      "tenantId": "{tenantId}",
      "code": "DISPVALID",
      "description": "Dispute Validated",
      "active": true,
      "isValid": true,
      "applyWhenInvoiceClosed": false,
      "createUser": "{userId}",
      "createDate": "2021-03-28T15:30:21.242Z",
      "updateUser": "{userId}",
      "updateDate": "2021-03-28T15:30:21.242Z"
    },
    ...
]

Creating a Resolution¶

Swagger Page¶

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

Permission¶

Dispute Configuration : CREATE

Example Request¶

curl -X POST 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/resolutions' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "code": "DISPVALID", "description": "Dispute Validated", "active": true, "isValid": true }'

Example Response¶

{
  "resolutionId": "{resolutionId}",
  "tenantId": "{tenantId}",
  "code": "DISPVALID",
  "description": "Dispute Validated",
  "active": true,
  "isValid": true,
  "applyWhenInvoiceClosed": false,
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T15:30:21.242Z"
}

Updating a Resolution¶

Swagger Page¶

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

Permission¶

Dispute Configuration : UPDATE

Example Request¶

curl -X PUT 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/resolutions/{resolutionId}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "description": "Dispute is Valid", "active": true, "isValid": true }'

Example Response¶

{
  "resolutionId": "{resolutionId}",
  "tenantId": "{tenantId}",
  "code": "DISPVALID",
  "description": "Dispute is Valid",
  "active": true,
  "isValid": true,
  "applyWhenInvoiceClosed": false,
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-30T12:12:00.000Z"
}

Deleting a Resolution¶

Swagger Page¶

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

Permission¶

Dispute Configuration : DELETE

Example Request¶

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

Deleting a resolution using code¶

Swagger Page¶

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

Permission¶

Dispute Configuration : DELETE

Example Request¶

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