Retrieve Payable History

Overview

This guide outlines the steps to retrieve the history of a specific payable using Payable API. Accessing the history is essential for users who need more than just the current state of a payable. It provides a complete record of the payable's activity over time.

This information is particularly beneficial for integrating into external applications where a detailed view of a payable's progression is necessary and for generating additional reports.

Step 1: Prepare the request

  • Endpoint: /Payables/{recordNumber}/history. Replace {recordNumber} with the unique identifier of the payable whose history you wish to retrieve.

  • Method: GET

Step 2: Send the GET API request

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

Step 3: Handle the response

If your API call is successful, the API will return a "200 OK" status code. This response will contain an array of payable activity log records.

Each record in the array will provide:

  • payableStatusId: A unique identifier for the status entry

  • status: The current status of the payable 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 payable was not found.

Example of the response

[
    {
        "payableStatusId": 1,
        "status": "Unprocessed",
        "message": "Payable with the record number 5014 has been created on 9/14/2023 11:40:55 AM",
        "createdOn": "2023-09-14 11:40:55.6747004 -04:00"
    },
    {
        "payableStatusId": 2,
        "status": "In Process",
        "message": "Payment for payable with the record number 5014 has been initiated via SmartDisburse on 9/14/2023 11:40:57 AM",
        "createdOn": "2023-09-14 11:40:57.6619755 -04:00"
    },
    {
        "payableStatusId": 4,
        "status": "Paid",
        "message": "SMART Disburse Payment Complete for payable with record number 5014 on 9/14/2023 11:51:24 AM",
        "createdOn": "2023-09-14 11:51:24.7644504 -04:00"
    }
]