Skip to content

User - Ledgers

Base URL: https://your-domain.com

Admin endpoints for managing ledgers and transaction history. All endpoints require admin/staff authentication.


Fetch All Ledgers

Retrieve transaction ledger entries with optional filters.

PropertyValue
EndpointFetch All Ledgers
MethodGET
URL/api/v1/ledgers
AuthenticationBearer Token

Request Headers:

HeaderValueRequired
Acceptapplication/jsonYes
AuthorizationBearer your-auth-tokenYes

Query Parameters:

ParameterTypeRequiredDescription
isp_idintegerYesISP ID
branch_idintegerYesBranch ID
user_idintegerYesUser ID
subscriber_idintegerNoFilter by subscriber
typestringNoFilter by type (credit, debit)
from_datedateNoStart date filter
to_datedateNoEnd date filter

Request Body: None

Success Response (200 OK):

json
{
    "success": true,
    "data": {
        "ledgers": [
            {
                "id": 1,
                "subscriber_id": 1,
                "subscriber_name": "John Doe",
                "type": "credit",
                "amount": 1000,
                "balance_after": 1500,
                "description": "Payment received",
                "reference": "PAY-2024-001",
                "created_at": "2024-01-15 10:30:00"
            }
        ],
        "total": 100,
        "total_credit": 50000,
        "total_debit": 45000
    }
}

Error Response (401 Unauthorized):

json
{
    "success": false,
    "message": "Unauthenticated"
}

www.onezeroart.com