Dispute Departments¶

All GET endpoints support an optional Accept-Language request header. When provided, the description field in the response is returned in the requested language if a translation exists. The response includes a Content-Language header indicating which language was applied.

Retrieving a Department by ID¶

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Example Response¶

See DisputeDepartmentV1Response.

Retrieving a Department by Code¶

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Example Response¶

See DisputeDepartmentV1Response.

Retrieving a List of Departments¶

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

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

Example Response¶

See Dispute Department List.

Creating a Department¶

Swagger Page¶

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

Permission¶

Dispute Configuration : CREATE

Example Request¶

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

Example Request Body¶

{
  "code": "SHIPDEPT",
  "description": "Shipping",
  "isDefault": false
}

Request Fields¶

Field	Type	Required	Description
`code`	string	Yes	Unique identifier for the department within the tenant
`description`	string	No	Display description of the department
`isDefault`	boolean	No	When `true`, this is the default department for the tenant. Setting this clears `isDefault` on all other departments

Behavior Notes¶

If a department with the same code already exists, this endpoint updates it rather than returning an error. Returns 201 on both create and upsert.

Example Response¶

See DisputeDepartmentV1Response.

Updating a Department¶

Swagger Page¶

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

Permission¶

Dispute Configuration : UPDATE

Example Request¶

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

Example Request Body¶

{
  "description": "Shipping Department",
  "isDefault": false
}

Request Fields¶

Field	Type	Required	Description
`description`	string	No	Updated display description
`isDefault`	boolean	No	When `true`, clears `isDefault` on all other departments

Example Response¶

See DisputeDepartmentV1Response.

Deleting a Department by ID¶

Swagger Page¶

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

Permission¶

Dispute Configuration : DELETE

Example Request¶

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

Behavior Notes¶

Returns 409 Conflict if any assignees belong to this department. Reassign or remove those assignees before deleting.

Deleting a Department by Code¶

Swagger Page¶

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

Permission¶

Dispute Configuration : DELETE

Example Request¶

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

Behavior Notes¶

Returns 409 Conflict if any assignees belong to this department.

Appendix¶

DisputeDepartmentV1Response¶

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

{
  "departmentId": "{departmentId}",
  "tenantId": "{tenantId}",
  "code": "SHIPDEPT",
  "description": "Shipping",
  "isDefault": false,
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T15:30:21.242Z"
}

Dispute Department List¶

Returned by Retrieving a List of Departments. An array of DisputeDepartmentV1Responses.

[
  {
    "departmentId": "{departmentId}",
    "tenantId": "{tenantId}",
    "code": "SHIPDEPT",
    "description": "Shipping",
    "isDefault": false,
    "createUser": "{userId}",
    "createDate": "2021-03-28T15:30:21.242Z",
    "updateUser": "{userId}",
    "updateDate": "2021-03-28T15:30:21.242Z"
  },
  ...
]