Billing

Modified on Wed, 05 Jul 2023 at 02:57 PM

BillingHeaders

The BilingHeaders endpoint allows you to retrieve available billings for a property using filters on:

StartDate/EndDate if you know the billing period (both optional)
LastUpdate if you want to get the billing published since a certain date (optional).

EndPoint	Http Verb	Description
/BillingHeaders/<propertyUUId> ?StartDate=yyyy-mm-dd&EndDate=yyyy-mm-dd&LastUpdate=yyyy-mm-dd	GET	Retrieve all billing header for a property You can filter on any of StartDate, EndDate or LastUpdate

{

"count": 3,

"billingHeaders": [

{

"id": 385619,

"propertyUUId": "2eff1042c50c1eda889e61573e3c194c",

"startDate": "2018-10-01T00:00:00",

"endDate": "2019-09-30T00:00:00",

"updateTimeStamp": "2023-07-03T22:00:26.16"

{

"id": 388568,

"propertyUUId": "2eff1042c50c1eda889e61573e3c194c",

"startDate": "2019-10-01T00:00:00",

"endDate": "2020-09-30T00:00:00",

"updateTimeStamp": "2023-07-03T22:00:26.16"

{

"id": 158567,

"propertyUUId": "2eff1042c50c1eda889e61573e3c194c",

"startDate": "2020-10-01T00:00:00",

"endDate": "2021-09-30T00:00:00",

"updateTimeStamp": "2023-07-03T22:00:26.16"

}

]

}

In the result you get the Billing period (StartDate, EndDate) and the updateTimeStamp (The moment the billing was published).

The first field "id" is the billing identifier that you will pass to the the next endpoint "Billing"

EndPoint	Http Verb	Description
/Billing/<id>?includeDeviceConsumptions=true/false	GET	Retrieve a particular billing. The flag includeDeviceConsumptions is indicating if you want the result to contain device consumptions.

In the Billing result above you will be able to get reference of .pdf billing document (Global and Individuals)

The reference is always "BExxxxxxxx" (Where "xxxxxxxx" is a 8 digits pattern)

EndPoint	Http Verb	Description
/BillingDoculment/<documentId>	GET	Download billing document