Credit Ledger Api
Credit Ledger
Description :
This API endpoint is used to get the credit ledger data of the user.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| month_year | Date | Yes | date in Y-m format |
Request Example
Responses (JSON)
- Description: Data fetched successfully.
- status_code (integer): The status code of the response (1).
- 'message' (string): "records successfully fetched"
- 'recordsTotal' (integer): "number or total records"
- 'recordsFiltered' (integer): "number or records filtered"
- data (object):
- particular (string): Transaction Particular (Payment-IN).
- payment_mode (string): mode of payment (Advance Credit).
- credit_debit (string): Credit/Debit Indicator (debit).
- pre_balance (string): Opening Balance (10).
- amount (string): Transaction Amount (10).
- current_balance (string): Closing Balance (0).
- 'created_date' (string): "date of record created"
- 'created_time' (string): "time of record created"
{"status_code": 2, "message": "month_year is required"}, 422
- Status Code 2: Validation Error
- Description: Validation error in the input parameters.
- 'status_code' (integer): 2
- 'message' (string): "A specific validation error message."
{"status_code": 0, "message": "records not found"}, 200
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "there is no data found"
Note
- The API endpoint should be accessed via a POST request.
- Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.