Skip to main content

Get List

GET 
/api/cashflow

Cash Flow API​

This endpoint allows users to retrieve cash flow data from the UdyogX application. It is designed to provide insights into the cash inflows and outflows for a specified period, helping users manage their financial activities effectively.

Request Parameters​

This is a GET request and does not require any input parameters in the request body. However, you may include query parameters in the URL to filter or specify the data you wish to retrieve.

Response Structure​

Upon a successful request, the API will return a JSON response containing the following key information:

  • cash inflows: A summary of all incoming cash transactions.
  • cash outflows: A summary of all outgoing cash transactions.
  • net cash flow: The difference between cash inflows and outflows for the specified period.
  • period: The time frame for which the cash flow data is being reported.

Example Response​

{
  "cash_inflows": [...],
  "cash_outflows": [...],
  "net_cash_flow": 0,
  "period": "YYYY-MM"
}

This structure allows users to easily understand their cash position and make informed financial decisions based on the retrieved data.

Responses​