Dispute Assignees¶

The assignee is the person at the tenant currently responsible for working the dispute. An assignee belongs to a department. Assignees can be created based on an existing Billtrust Platform user by supplying a valid User ID during the create process.

Retrieving an Assignee¶

This endpoint can be used to return a single assignee by their email address.

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Example Response¶

{
  "id": "{assigneeId}",
  "createUser": "{userId}",
  "createDate": "2021-03-27T18:50:05.300Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-27T18:50:05.300Z",
  "assigneeId": "{assigneeId}",
  "departmentId": "{departmentId}",
  "active": true,
  "tenantId": "{tenantId}",
  "userId": "{assigneeUserId}",
  "allUpdates": true,
  "dailyDigest": true,
  "person": {
    "firstName": "Steve",
    "lastName": "Rogers",
    "email": "steve.rogers@avengers.com",
    "officePhone": "13334445555",
    "cellPhone": "13334445555",
    "fax": null,
    "title": "Captain",
    "address": {
      "address1": "100 Broadway",
      "address2": null,
      "city": "New York",
      "state": "NY",
      "zip": "11234",
      "country": "US"
    },
    "language": "en",
    "timezone": "America/New York"
  }
}

Retrieving a List of Assignees¶

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Request Filters¶

Field	Description	Match Type
DepartmentId	The internal ID of the assignee's department	Full match only

Example Response¶

[
    {
        "id": "{assigneeId}",
        "createUser": "{userId}",
        "createDate": "2021-03-27T18:50:05.300Z",
        "updateUser": "{userId}",
        "updateDate": "2021-03-27T18:50:05.300Z",
        "assigneeId": "{assigneeId}",
        "departmentId": "{departmentId}",
        "active": true,
        "tenantId": "{tenantId}",
        "userId": "{assigneeUserId}",
        "allUpdates": true,
        "dailyDigest": true,
        "person": {
            "firstName": "Steve",
            "lastName": "Rogers",
            "email": "steve.rogers@avengers.com",
            "officePhone": "13334445555",
            "cellPhone": "13334445555",
            "fax": null,
            "title": "Captain",
            "address": {
            "address1": "100 Broadway",
            "address2": null,
            "city": "New York",
            "state": "NY",
            "zip": "11234",
            "country": "US"
            },
            "language": "en",
            "timezone": "America/New York"
        }
    },
    ...
]

Creating an Assignee¶

Swagger Page¶

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

Permission¶

Dispute Configuration : CREATE

Example Request¶

In the request body, a department's internal identifier (departmentId) and/or a departments's external code (departmentCode) must be specified in order to create an assignee.

curl -X POST 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/assignees' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "departmentId" : "{departmentId}", "active": true, "userId": null, "allUpdates": true, "dailyDigest": true, "person": { "firstName": "Steve", "lastName": Rogers", "email": "steve.rogers@avengers.com", "address": {"address1":"address-1","address2":"address-2","city":"test city","state":"TX","zip":"12356","country":"USA" }, "language": "en", "timeZone": "America/New York" } }'

Example Response¶

{
  "id": "{assigneeId}",
  "createUser": "{userId}",
  "createDate": "2021-03-27T18:50:05.300Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-27T18:50:05.300Z",
  "assigneeId": "{assigneeId}",
  "departmentId": "{departmentId}",
  "active": true,
  "tenantId": "{tenantId}",
  "userId": "{assigneeUserId}",
  "allUpdates": true,
  "dailyDigest": true,
  "person": {
    "firstName": "Steve",
    "lastName": "Rogers",
    "email": "steve.rogers@avengers.com",
    "officePhone": "13334445555",
    "cellPhone": "13334445555",
    "fax": null,
    "title": "Captain",
    "address": {
      "address1": "100 Broadway",
      "address2": null,
      "city": "New York",
      "state": "NY",
      "zip": "11234",
      "country": "US"
    },
    "language": "en",
    "timezone": "America/New York"
  }
}

Updating an Assignee¶

Swagger Page¶

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

Permission¶

Dispute Configuration : UPDATE

Example Request¶

In the request body, a department's internal identifier (departmentId) and/or a departments's external code (departmentCode) must be specified in order to update an assignee.

curl -X PUT 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/assignees/by-email/{assigneeEmail}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "departmentId" : "{departmentId}", "active": true, "userId": null, "allUpdates": true, "dailyDigest": true, "person": { "firstName": "Steve", "lastName": Rogers", "email": "steve.rogers@avengers.com" ,"address": {"address1":"address-1","address2":"address-2","city":"test city","state":"TX","zip":"12356","country":"USA" }, "language": "en", "timeZone": "America/New York" } }'

Example Response¶

{
  "id": "{assigneeId}",
  "createUser": "{userId}",
  "createDate": "2021-03-27T18:50:05.300Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-27T18:50:05.300Z",
  "assigneeId": "{assigneeId}",
  "departmentId": "{departmentId}",
  "active": true,
  "tenantId": "{tenantId}",
  "userId": "{assigneeUserId}",
  "allUpdates": true,
  "dailyDigest": true,
  "person": {
    "firstName": "Steve",
    "lastName": "Rogers",
    "email": "steve.rogers@avengers.com",
    "officePhone": "13334445555",
    "cellPhone": "13334445555",
    "fax": null,
    "title": "Captain",
    "address": {
      "address1": "100 Broadway",
      "address2": null,
      "city": "New York",
      "state": "NY",
      "zip": "11234",
      "country": "US"
    },
    "language": "en",
    "timezone": "America/New York"
  }
}

Deleting an Assignee¶

Swagger Page¶

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

Permission¶

Dispute Configuration : DELETE

Example Request¶

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

Deleting an assignee using assignee email¶

Deletes the dispute assignee associated to a department using email address.

Swagger Page¶

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

Permission¶

Dispute Configuration : DELETE

Example Request¶

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