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

api: Added History to Billing API Functions (#8209)

Browse Source 
* Add Previous Period options to Bill API functions

* Add Bill History API Functions
This commit is contained in:
Richard Lawley
2018-02-09 21:14:55 +00:00
committed by Neil Lathwood
parent 2793958f05
commit 2018c9f804
3 changed files with 94 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
doc/API/Bills.md
View File

@@ -5,12 +5,14 @@ source: API/Bills.md
Retrieve the list of bills currently in the system.
Route: `/api/v0/bills`
`/api/v0/bills?period=previous`
Input:
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills?period=previous
```
Output:
@@ -64,12 +66,16 @@ Output:
Retrieve a specific bill
Route: `/api/v0/bills/:id`
`/api/v0/bills/:id?period=previous`
`/api/v0/bills?ref=:ref`
`/api/v0/bills?ref=:ref&period=previous`
`/api/v0/bills?custid=:custid`
`/api/v0/bills?custid=:custid&period=previous`
- id is the specific bill id
- ref is the billing reference
- custid is the customer reference
- period=previous indicates you would like the data for the last complete period rather than the current period
Input:
@@ -125,3 +131,49 @@ Output:
]
}
```
### `get_bill_history`
Retrieve the history of specific bill
Route: `/api/v0/bills/:id/history`
Input:
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bills/1/history
```
Output:
```json
{
"status": "ok",
"bill_history": [
{
"bill_hist_id": "1",
"bill_id": "1",
"updated": "2018-02-06 17:01:01",
"bill_datefrom": "2018-02-01 00:00:00",
"bill_dateto": "2018-02-28 23:59:59",
"bill_type": "CDR",
"bill_allowed": "100000000",
"bill_used": "229963765",
"bill_overuse": "129963765",
"bill_percent": "229.96",
"rate_95th_in": "229963765",
"rate_95th_out": "1891344",
"rate_95th": "229963765",
"dir_95th": "in",
"rate_average": "136527101",
"rate_average_in": "135123359",
"rate_average_out": "1403743",
"traf_in": "3235123452544",
"traf_out": "33608406566",
"traf_total": "3268731859110",
"pdf": null
}
],
"count": 1,
}
```