Dispute Resolutions¶

Retrieving a Resolution by ID¶

Swagger Page¶

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

Permission¶

Dispute Configuration : READ

Example Request¶

curl -X GET '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>'

Example Response¶

See DisputeResolutionV1Response.

Retrieving a Resolution by 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¶

See DisputeResolutionV1Response.

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¶

See Dispute Resolution List.

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

Example Request Body¶

{
  "code": "DISPVALID",
  "description": "Dispute Validated",
  "active": true,
  "isValid": true
}

Request Fields¶

Field	Type	Required	Description
`code`	string	Yes	Unique identifier for the resolution within the tenant. Stored as uppercase
`description`	string	No	Display description of the resolution
`active`	boolean	No	Whether the resolution is active; defaults to `false`
`isValid`	boolean	No	Whether selecting this resolution marks the dispute as valid; defaults to `false`

Behavior Notes¶

If a resolution 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 DisputeResolutionV1Response.

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

Example Request Body¶

{
  "description": "Dispute is Valid",
  "active": true,
  "isValid": true
}

Request Fields¶

Field	Type	Required	Description
`description`	string	No	Updated display description
`active`	boolean	No	Whether the resolution is active
`isValid`	boolean	No	Whether selecting this resolution marks the dispute as valid

Example Response¶

See DisputeResolutionV1Response.

Setting the Invoice-Closed Resolution¶

Sets this resolution as the one automatically applied when an invoice is closed. Only one resolution per tenant can have this flag set, calling this endpoint clears applyWhenInvoiceClosed on all other resolutions first.

Swagger Page¶

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

Permission¶

Dispute Configuration : UPDATE

Example Request¶

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

Example Response¶

See DisputeResolutionV1Response.

Deleting a Resolution by ID¶

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

Behavior Notes¶

Returns 409 Conflict if the resolution is linked to any dispute. Reassign those disputes to a different resolution before deleting.

Deleting a Resolution by 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>'

Behavior Notes¶

Returns 409 Conflict if the resolution is linked to any dispute.

Appendix¶

DisputeResolutionV1Response¶

Returned by single-resolution endpoints (Get by ID, Get by Code, Create, Update, Set Invoice-Closed).

{
  "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"
}

Dispute Resolution List¶

Returned by Retrieving a List of Resolutions. An array of DisputeResolutionV1Responses.

[
  {
    "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"
  },
  ...
]