Retrieving Receivable History

Overview

Use this guide to learn how to fetch the history of a specific receivable with the Receivable API. For those who want to see more than the status of a receivable, this historical data can be useful. It shows all past activities and changes. This history is handy for users looking to integrate the data into other applications or for creating reports. 

Step 1: Prepare the GET request

  • Endpoint: /Receivables/{recordNumber}/history. Remember to replace {recordNumber} with the identifier of the receivable you're targeting. 

  • Method: GET 

Step 2: Send the GET API request

Use the tool or method you're comfortable with, such as a command line tool, Postman, or a script, to send the GET request to the provided endpoint. 

Step 3: Handle the response

If the API call works, you'll get a "200 OK" status code. The response will have an array that lists the receivable's activity logs. 

Each record in the array will provide:

  • receivableStatusId: A unique identifier for the status entry

  • status: The current status of the receivable at that point in its history

  • message: A message or description related to the status change

  • createdOn: The date and time when the status was recorded

If the recordNumber does not exist in the system, the API will return a "404 Not Found" status code, indicating that the receivable was not found.

Example of the response

[
    {
        "receivableStatusId": 1,
        "status": "Unprocessed",
        "message": "Receivable with the record number 6015 has been created on 9/15/2023 10:20:30 AM",
        "createdOn": "2023-09-15 10:20:30.6747004 -04:00"
    },
    {
        "receivableStatusId": 2,
        "status": "In Process",
        "message": "Collection for receivable with the record number 6015 has been initiated via SmartCollect on 9/15/2023 10:25:33 AM",
        "createdOn": "2023-09-15 10:25:33.6619755 -04:00"
    },
    {
        "receivableStatusId": 4,
        "status": "Paid",
        "message": "SMART Collect Completion for receivable with record number 6015 on 9/15/2023 10:40:15 AM",
        "createdOn": "2023-09-15 10:40:15.7644504 -04:00"
    }
]