mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated billing features within API + docs

Browse Source
This commit is contained in:
laf
2015-07-02 23:19:46 +01:00
parent 1de57eef5f
commit 715f2a19b3
2 changed files with 191 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
doc/API/API-Docs.md
View File

@@ -34,6 +34,9 @@
- [`edit_rule`](#api-route-19)
- [`inventory`](#api-inventory)
- [`get_inventory`](#api-route-20)
- [`bills`](#api-bills)
- [`list_bills`](#api-route-22)
- [`get_bill`](#api-route-23)
Describes the API structure.
# <a name="api-structure">`Structure`</a> [`top`](#top)
@@ -812,3 +815,118 @@ Output:
]
}
```
## <a name="api-bills">`Bills`</a> [`top`](#top)
### <a name="api-route-22">Function: `list_bills`</a> [`top`](#top)
Retrieve the list of bills currently in the system.
Route: /api/v0/bills
Input:
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills
```
Output:
```text
{
"status": "ok",
"err-msg": "",
"count": 1,
"bills": [
{
"bill_id": "1",
"bill_name": "Router bills",
"bill_type": "cdr",
"bill_cdr": "10000000",
"bill_day": "1",
"bill_quota": "0",
"rate_95th_in": "0",
"rate_95th_out": "0",
"rate_95th": "0",
"dir_95th": "in",
"total_data": "0",
"total_data_in": "0",
"total_data_out": "0",
"rate_average_in": "0",
"rate_average_out": "0",
"rate_average": "0",
"bill_last_calc": "2015-07-02 17:01:26",
"bill_custid": "Router",
"bill_ref": "Router",
"bill_notes": "Bill me",
"bill_autoadded": "0",
"ports_total": "0",
"allowed": "10Mbps",
"used": "0bps",
"percent": 0,
"overuse": "-"
}
]
}
```
### <a name="api-route-23">Function: `get_bill`</a> [`top`](#top)
Retrieve a specific bill
Route: /api/v0/bills/:id
/api/v0/bills?ref=:ref
/api/v0/bills?custid=:custid
- id is the specific bill id
- ref is the billing reference
- custid is the customer reference
Input:
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills/1
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills?ref=:customerref
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills?custid=:custid
```
Output:
```text
{
"status": "ok",
"err-msg": "",
"count": 1,
"bills": [
{
"bill_id": "1",
"bill_name": "Router bills",
"bill_type": "cdr",
"bill_cdr": "10000000",
"bill_day": "1",
"bill_quota": "0",
"rate_95th_in": "0",
"rate_95th_out": "0",
"rate_95th": "0",
"dir_95th": "in",
"total_data": "0",
"total_data_in": "0",
"total_data_out": "0",
"rate_average_in": "0",
"rate_average_out": "0",
"rate_average": "0",
"bill_last_calc": "2015-07-02 17:01:26",
"bill_custid": "Router",
"bill_ref": "Router",
"bill_notes": "Bill me",
"bill_autoadded": "0",
"ports_total": "0",
"allowed": "10Mbps",
"used": "0bps",
"percent": 0,
"overuse": "-"
}
]
}
```