GET api/BillingImportExport/ExportProfile?profileName={profileName}&numberDaysWindow={numberDaysWindow}&billingDate={billingDate}

Export billing profile details in JSON/XML format

Request Information

URI Parameters

NameDescriptionType
profileName

Billing profile name

string
numberDaysWindow

Number of days window the API will look back if data is unavailable for the requested day

integer
billingDate

Date for which billing status is needed

date

Header

NameDescriptionType
Authorization

This field is use to authenticate user using 'Bearer Token'.This token is generated using login method.User must add this token to the header.
Key = Authorization
Value = Bearer {Token}

string

Body Parameters

None.

Response Information

Resource Description

Collection of BillingProfileExportViewModel
NameDescriptionType
Meter_ID

This is a unique number identifying the meter

string
Consumer_ID

This is the number identifying the consumer associated to the meter

string
Consumer_Name

This is the name of the consumer associated to the meter

string
Service_Address

The address of consumer associated to meter

string
LCD_Read

This is the numeric value displayed in the digital format on the endpoint

decimal number
Billing_Read

It is the value exported for billing purpose

string
Read_Date

This is the last communication date of the meter with system

string
Unit

This is the consumption measurement unit of the meter

string

Response Formats

application/json, text/json

Sample:
[
  {
    "Meter_ID": "3003009",
    "Consumer_ID": "78905231",
    "Consumer_Name": "James",
    "Service_Address": "Florida",
    "LCD_Read": 3003005.0,
    "Billing_Read": "3003005",
    "Read_Date": "05/15/2018",
    "Unit": "G"
  },
  {
    "Meter_ID": "3003008",
    "Consumer_ID": "78905232",
    "Consumer_Name": "Jack",
    "Service_Address": "Florida",
    "LCD_Read": 1035787.0,
    "Billing_Read": "1035787",
    "Read_Date": "05/15/2018",
    "Unit": "G"
  }
]

application/xml, text/xml

Sample:
<?xml version="1.0" encoding="utf-16"?>
<ArrayOfBillingProfileExportViewModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BillingProfileExportViewModel>
    <Meter_ID>3003009</Meter_ID>
    <Consumer_ID>78905231</Consumer_ID>
    <Consumer_Name>James</Consumer_Name>
    <Service_Address>Florida</Service_Address>
    <LCD_Read>3003005</LCD_Read>
    <Billing_Read>3003005</Billing_Read>
    <Read_Date>05/15/2018</Read_Date>
    <Unit>G</Unit>
  </BillingProfileExportViewModel>
  <BillingProfileExportViewModel>
    <Meter_ID>3003008</Meter_ID>
    <Consumer_ID>78905232</Consumer_ID>
    <Consumer_Name>Jack</Consumer_Name>
    <Service_Address>Florida</Service_Address>
    <LCD_Read>1035787</LCD_Read>
    <Billing_Read>1035787</Billing_Read>
    <Read_Date>05/15/2018</Read_Date>
    <Unit>G</Unit>
  </BillingProfileExportViewModel>
</ArrayOfBillingProfileExportViewModel>