Scheduling SMART-Collect Receivable

Overview 

This guide will instruct you on using the Receivable API to schedule a collection request for a future date. Scheduling collections in advance provides users with enhanced control over their collection process, ensuring they align with crucial collection dates without the requirement for on-the-spot processing. 

Even after scheduling, you have the option to update or cancel the receivable. 

On the designated "receivableEffectiveDate", the Receivable API will carry out the collection request automatically. 

Step 1: Prepare the request 

Endpoint: /Receivables 

Method: POST 

Body: For the request body, include all the required fields for a typical collection. Also, define the receivableEffectiveDate, a dateTime value that denotes when the collection should take place. Make sure this date is set for a future moment. 

Step 2: Send the POST request 

Using your chosen tool (command line, Postman, or another script), transmit the POST request to the given endpoint. 

Step 3: Handle the response 

Upon scheduling the collection, the API will respond with a "202 Accepted" status code. This acknowledgment will provide you with the recordNumber for the planned receivable. 

The status of this receivable will be marked as "Scheduled". The collection will occur on the date outlined in receivableEffectiveDate. 

If necessary, you can modify or cancel a scheduled receivable.