Skip to main content

Add Single Income

POST 
/api/cashflow

Add Cashflow Entry​

This endpoint allows users to add a new cashflow entry to the system. It accepts a POST request with a JSON payload containing various parameters related to the cashflow entry.

Request Method​

  • POST

Endpoint​

Request Parameters​

The request body should be a JSON object with the following parameters:

  • qtype (string): Specifies the type of query, typically set to "api".
  • path (string): The path for the cashflow entry, e.g., "cashflow/entry/new".
  • pg (string): The page context, e.g., "form/cashflow/entry".
  • cash_type (string): The type of cashflow, e.g., "income".
  • date (string): The date of the cashflow entry in YYYY-MM-DD format.
  • payable (string): The amount payable (if applicable).
  • paid (string): The amount that has been paid.
  • payment_mode (string): The mode of payment, e.g., "CASH".
  • remark (string): Any additional remarks regarding the transaction.
  • cash_type_remark (string): Remarks specific to the cash type.
  • payee_type (string): The type of payee, e.g., "student".
  • additional_info (string): Any additional information related to the entry.
  • cash_id (string): The ID of the cash entry (if applicable).
  • payee_id (string): The ID of the payee.
  • session (string): The session year, e.g., "2023-24".

Expected Response Format​

The response will typically include a confirmation of the entry creation, along with relevant details such as the status of the request and any generated identifiers for the new cashflow entry. The exact structure of the response may vary based on the implementation but will generally indicate success or failure of the operation.

Ensure that all required parameters are included in the request to avoid errors.

Request​

Responses​