Canceling a SMART-Collect Receivable with the Receivables API

Overview 

There may be times when a SMART-Collect request needs to be canceled due to reasons such as having an incorrect collection email address or the necessity to adjust collection details. Even if the receivable is marked as "In Process", you can still cancel the SMART-Collect request. 

Step 1: Prepare the PUT request 

Endpoint: /receivables/{recordNumber}/cancel. Ensure you replace {recordNumber} with the distinct identifier of the receivable you aim to cancel. 

Method: PUT 

Step 2: Send the PUT request 

Use your chosen tool or method, whether it's the command line, Postman, or another script, to forward the PUT request to the specified endpoint. 

Step 3: Handle the response 

Upon successful cancellation of the SMART-Collect request, the API will return a "202 Accepted" status code. The status of the receivable will then change to "Canceled". The existing SMART-Collect link associated with the request will be revoked. 

Note: After canceling a SMART-Collect request, you can modify and re-run it using the appropriate update API call.