Method GetCurrentCharges

Summary

Returns customer's current bill charges

Remarks

Provides a quick view of the charges and amount due on the customer’s current bill.

Common uses:

This returns a seperate row for each utility service.

For example, if the customer has water and electricity services, then the method returns one row for water, and another set for electricity.

The remaining OutputParms are returned only once for the customer, and are the total bill amount for all services.

Input Parameters

NameTypeLengthDescription
customerNumber numeric 9 [Required] Customer Number. See Account Search methods.
locationNumber numeric 9 [Required] Location Number. See Account Search methods.
BillDate date 0 [Required] Billing Date in YYMMDD format. See GetUtilitiesBilling method.

Example

GET http://localhost/FusionServices/v2/Naviline/Utilities/{CustomerNumber}/{LocationNumber}/billing/{BillDate}/charges

Return Values

NameDescription
ServiceCode Two letter code indicating the type of utility service. Example: WA for WATER
ReadDate The date the meter was read. Format: mmddyyyy
ReadType Description of the type of meter read taken. Example: MONTHLY or FINAL
MeterNumber Meter identification number.
Days Number of days included in the meter read.
TotalActualConsumption The total amount of the utility service that was consumed. See GetMeterDetail for units this is measured in.
TotalDemandConsumption The total amount of overage demand for the utility service. Overage demand occurs when the customer’s consumption exceeds a set limit. This demand amount is normally charged at a higher rate. See GetMeterDetail for units this is measured in.
DueDate Date bill was due. Format: mmddyyyy
Payments Amount of bill paid.
CurrentCharges Amount of charges applied this bill period.
BillAmount Total amount due
CurrentBalance Amount of current account balance.

Sample Responses

Sample Code

using System.Net;
using Newtonsoft.Json.Linq;

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/Utilities/000000101/000033028/billing/121224/charges";
    WebClient wc = new WebClient();
    wc.Headers.Set("X-APPID", "YOURID");
    wc.Headers.Set("X-APPKEY", "YOURKEY");
    string stringResult = wc.DownloadString(new Uri(uri));
    
    JObject response = JObject.Parse(stringResult);
    string error = response["OutputParms"]["ErrorCode"].ToString();
    if (error == "0000")
    {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string ServiceCode = row["ServiceCode"].ToString();
             string ReadDate = row["ReadDate"].ToString();
             string ReadType = row["ReadType"].ToString();
             string MeterNumber = row["MeterNumber"].ToString();
             string Days = row["Days"].ToString();
             string TotalActualConsumption = row["TotalActualConsumption"].ToString();
             string TotalDemandConsumption = row["TotalDemandConsumption"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/Utilities/000000101/000033028/billing/121224/charges', function(response) {
    $('#resultDiv).html(response); 
 });

C# Razor MVC Sample Code

using System;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
using System.Collections.Specialized;
using FusionServiceHelper.Models;

// NOTE: Use the namespace generated when you add the class, so that it is correct.
namespace FusionRazor.Models
{
   public class GetCurrentCharges
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,9}", ErrorMessage = "Numeric values only. Must be 9 digits or less. ")]
       public string customerNumber{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,9}", ErrorMessage = "Numeric values only. Must be 9 digits or less. ")]
       public string locationNumber{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("^\\d\\d(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$", ErrorMessage = "Date values only. Format: YYMMDD")]
       public string BillDate{get; set;}

       public GetCurrentCharges()
       {
           //Set any defaults here
           customerNumber = DefaultData.Get("customerNumber");
           locationNumber = DefaultData.Get("locationNumber");
           BillDate = DefaultData.Get("BillDate");
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the GetCurrentCharges class. *@
@* NOTE: Select Edit as the Scaffold template. *@
@* NOTE: Use the @model line that is generated at the top.  Replace the rest with the lines below.
@model FusionRazor.Models.GetCurrentCharges

@{
   ViewBag.Title = "GetCurrentCharges";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/Utilities/" + Model.CustomerNumber + "/" + Model.LocationNumber + "/billing/" + Model.BillDate + "/charges";
}

<h2>GetCurrentCharges</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetCurrentCharges</legend>
       <div class="editor-label">Use the fields below to change the values and resubmit.</div>
       <div class="editor-label">
           @Html.LabelFor(model => model.customerNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.customerNumber)
           @Html.ValidationMessageFor(model => model.customerNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.locationNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.locationNumber)
           @Html.ValidationMessageFor(model => model.locationNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.BillDate)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.BillDate)
           @Html.ValidationMessageFor(model => model.BillDate)
       </div>
       <p>
       <input type="submit" value="Submit"/>
       </p>
   </fieldset>

}

@section Scripts {
   @Scripts.Render("~/bundles/jqueryval")
}
using System;
using System.Collections.Specialized;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using FusionServiceHelper.Models;

// NOTE: Replace 'MyController' with the name of your controller.

// 
// GET: /MyController/GetCurrentCharges
public ActionResult GetCurrentCharges()
{
   // Create a new instance of the model to pick up any default values.
   GetCurrentCharges model =  new GetCurrentCharges();

   // pass model to set to default values
   // NOTE: Change 'MyFolderPath' to the path to the .cshtml file.
   return View("~/Views/MyFolderPath/GetCurrentCharges.cshtml", model);
}

// 
// POST: /MyController/GetCurrentCharges
[HttpPost]
public ActionResult GetCurrentCharges(FormCollection collection)
{
   string url = "v2/Naviline/Utilities/{CustomerNumber}/{LocationNumber}/billing/{BillDate}/charges";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("customerNumber", collection["customerNumber"]);
   inputParms.Add("locationNumber", collection["locationNumber"]);
   inputParms.Add("BillDate", collection["BillDate"]);

   try
   {
       // Send the request
       FusionServiceRequest request = new FusionServiceRequest();
       FusionServiceResult result = request.Get(url, inputParms);

       return View("Result", result);
   }
   catch(Exception e)
   {
       HandleErrorInfo info = new HandleErrorInfo(e, "MyController", "GetCurrentCharges");
       return View("Error", info);
   }
}