Canceling a Scheduled Receivable collection with the Receivables API

Overview

Cancelling a Scheduled Receivable Collection allows the payee to revoke a previously scheduled collection of payment from the payor. This action is applicable only for receivables in the "Scheduled" status. By cancelling a scheduled collection, the payee can update payment terms, reschedule the collection, or explore alternative payment methods. 

Step 1: Prepare the PUT Request 

You will need to make a PUT request to the Receivables endpoint of the API to update the status of a receivable. The endpoint URL should be in this format: 

Endpoint: /receivables/{recordNumber}/cancel. Replace {recordNumber} with the unique identifier of the receivable whose status and details you want to cancel. 

Method: PUT

Step 2: Send the PUT Request 

Using your preferred method (command line, Postman, or a script), send the PUT request to the endpoint. 

Step 3: Handle the Response 

The API will respond with a status code to indicate whether the operation was successful. If successful, the status of the receivable will be updated to "Canceled" in your system. 

If the operation fails, ensure that the recordNumber is correct and that the receivable is in a status that allows cancellation (i.e., it hasn't already been processed or canceled). 

Remember, canceling a scheduled receivable means that it won't be processed as planned, but it will still exist in your system. You can update it or re-initiate the receivable at a later time if necessary.