Updating and Re-Initiating a Receivable with the Receivables API

Overview

The Updating and Re-Initiating a Receivable process allows for making changes to a receivable that is in a Unprocessed, Scheduled, Failed or Canceled status. By updating the receivable, you can modify the details, such as the net total, payment terms, or remittance information. Once the necessary changes have been made, you can re-initiate the receivable to restart the payment process. 

Step 1: Prepare the PUT Request 

Make a PUT request to the Receivables endpoint of the API to update the details of a receivable. The endpoint URL should be in this format: 

Endpoint: /receivables/{recordNumber}. Replace {recordNumber} with the unique identifier of the receivable you want to update. The body of the request should contain the updated receivable details. 

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 details of the receivable will be updated in your system. 

Remember that receivables can only be updated if their status is "Unprocessed", "Scheduled", "Failed" or "Canceled". If you attempt to update a receivable in any other status, the operation will fail.