Payment Collection Api
Payment Collection
Description :
This API endpoint is used to get the Report of Payment Collection.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| from_date | Date | Yes | date in Y-m-d format | |||
| to_date | Date | Yes | date in Y-m-d format | |||
| user_id | string | No | user id here |
Request Example
Responses (JSON)
- 'status_code' (integer): 1
- 'message' (string): "records successfully fetched"
- 'recordsTotal' (integer): "number or total records"
- 'recordsFiltered' (integer): "number or records filtered"
- data (object):
- id (string): id of the record.
- type (string): It will contain credit/debit.
- user_id (string): Like a RP01.
- full_name (string): Name of the user.
- company_name (string): Shop name of the user.
- mobile_no (string): Mobile number of the user.
- opening_bal (string): Opening balance of the user.
- amount (string): Amount.
- closing_bal (string): Closing balane of the user.
- payment_mode (string): Payment mode of collection.
- refrence (string): utr no.
- remark (string): remark here.
- bank_name (string): bank name here.
- account_no (string): account no here.
- created_date (string): "date of record created"
- created_time (string): "time of record created"
{"status_code": 2, "message": "from_date 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.