Retrieving Receivable Details and Status

Overview

The Receivable Status retrieval is a crucial feature of the Receivables API. This functionality allows you to retrieve the current status and detailed information of a specific receivable transaction. By accessing the API endpoint and handling the response, you can monitor the progress of the transaction and obtain real-time updates on its status. 

Step 1: Prepare the GET Request 

You'll need to make a GET request to the Payables endpoint of the API. The endpoint URL should be in this format: 

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

Method: GET

Step 2: Send the GET Request 

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

Step 3: Handle the Response 

The API will respond with a JSON object that contains information about the receivable. Look for the status field in the response to find the current status of the payable, and other fields for additional details. 

Possible Payable Statuses 

The status of a payable can be one of the following: 

• Unprocessed: The receivable is created but has not yet been processed. 

• Scheduled: The receivable is scheduled but has not yet been processed. 

• In Process: The receivable is currently being processed. 

• Canceled: The receivable was canceled by the user. 

• Paid: The receivable has been successfully completed. 

• Failed: The receivable failed due to some reason.