api.hirepos.com/DispatchedToday

Edited

Welcome to the DispatchedToday endpoint documentation. This endpoint is designed to provide information on Item Codes where the Hired From date is populated. The endpoint retrieves data based on whether the Hired From date is available at the Invoice Line level or at the Invoice level.

Endpoint Details

The DispatchedToday endpoint returns an array of Item Codes along with the corresponding Hired From date. The logic for determining the Hired From date is as follows:

  • If the Hired From date is populated at the Invoice Line level, that specific date is used.

  • If the Hired From date is not available at the Invoice Line level, the Hired From date at the Invoice level is utilized.

Usage

To access the DispatchedToday endpoint, make a GET request to the designated URL. The response will include an array of Item Codes and their respective Hired From dates based on the logic described above.

Example

Here is an example of how the DispatchedToday endpoint response may look:

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

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

// Example Response...

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

Conclusion

In conclusion, the DispatchedToday endpoint is a valuable tool for retrieving Item Codes along with their corresponding Hired From dates. By understanding the logic behind the date retrieval process, users can effectively utilize this endpoint to access the necessary information.