api.hirepos.com/ReturnedToday

Edited

This document provides information about the ReturnedToday endpoint in the hirepos system.

Overview

The ReturnedToday endpoint is designed to return an array of Item Codes where the Hired To date is populated. The endpoint functions by prioritizing the Hired To date at the Invoice Line level. If the Hired To date is not populated at the Invoice Line level, the system will default to using the Hired To date at the Invoice level.

Functionality

When a request is made to the ReturnedToday endpoint, the system will retrieve and return a list of Item Codes that meet the criteria of having a populated Hired To date. The endpoint ensures that accurate and up-to-date information is provided to users.

Usage

To utilize the ReturnedToday endpoint, users can make a request specifying the necessary parameters to retrieve the desired information. The endpoint streamlines the process of accessing Item Codes based on the Hired To date, simplifying data retrieval for users.

Example

GET https://api.hirepos.com/ReturnedToday

Headers:
AuthKey={YourAPIKey}
AuthSecret={YourAPISecret}

// Example Response...

[
    {
        "ItemCode": "H1",
        "InvoiceNo": "1000",
        "CustomerCode": "CUST0001"
    }
]

Conclusion

The ReturnedToday endpoint in hirepos provides a convenient way to retrieve Item Codes based on the Hired To date criteria. By prioritizing the Hired To date at the Invoice Line level and falling back to the Invoice level when necessary, the endpoint ensures accurate data retrieval for users.