v1
latestOpenAPI 3.0.12026-07-265331168.0 KBResidential Ledger
Retrieve Residential Ledger
Retrieves a specific Residential Ledger based on the provided ID for the current user's account.
get/public/user/residential_ledger/retrieve/{residential_ledger_id}
Path parameters
residential_ledger_idstring required
ID of the Residential Ledger to retrieve
Response
Successful Residential Ledger Retrieve
Example response
{
"data": {
"customer_id": 1955,
"residential_ledger_bytes": 128290101,
"residential_ledger_creation_datetime": "2023-04-01 12:00:00",
"residential_ledger_id": "123e4567-e89b-12d3-a456-426614174000",
"residential_ledger_last_update_datetime": "2023-04-02 12:00:00",
"residential_ledger_period_date": "2023-10-01",
"residential_ledger_reason": "top_up",
"residential_ledger_requests": 1244,
"service_adjustment_id": 10,
"service_id": "API-1234-5678"
},
"message": "Residential Ledger successfully retrieved."
}