v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Residential Ledger

Search Residential Ledger

Search for entries in the Residential Ledger using various filters.

get/public/user/residential_ledger/search

Query parameters

residential_ledger_idstring

Unique identifier of the Residential Ledger entry.

service_idstring

Service identifier associated with the ledger entry.

service_adjustment_idinteger

Adjustment identifier associated with the ledger entry.

residential_ledger_reasonstring

Reason for the ledger entry.

residential_ledger_requestsinteger

Number of requests recorded in the ledger entry.

residential_ledger_bytesinteger

Data usage in bytes recorded in the ledger entry.

residential_ledger_period_datestring

The date of the ledger entry.

residential_ledger_creation_datetimestring

Creation datetime of the ledger entry.

residential_ledger_last_update_datetimestring

Last update datetime of the ledger entry.

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Residential Ledger search

item_countinteger

Total number of Residential Ledger items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Residential Ledger items returned per page.

total_countinteger

Total of Residential Ledger items that match the search filter.

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"
    }
  ],
  "item_count": 1,
  "message": "Residential Ledger search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}