Method GetPaymentDetail

Summary

Returns the payment transaction details

Remarks

This gives information on how the payment was received, along with the date and amount.

Common uses:

Retrieve list of payments, including date and amount

Input Parameters

Name	Type	Length	Description
customerNumber	numeric	9	[Required] Customer Number. See Account Search methods.
locationNumber	numeric	9	[Required] Location Number. See Account Search methods.
BillDate	date	6	[Required] Billing Date in YYMMDD format. Or '999999' for all since last bill. Use the GetUtilitiesBilling method to get a list of payments and their billing date.

Example

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

Return Values

Name	Description
Type	Type of payment. Normally PAYMENT, or REFUND.
TransactionType	Two letter transaction type code. Example: DW, MA, OC, DR
Description	Description for transaction type code. Example: DW = Drive up Window MA = Mail In OC = Over the Counter DR = Deposit Refund
TransactionDate	Date payment was made. Format: YYMMDD
ReferenceDate	Reference number associated with the payment
Amount	Amount of payment applied to the account.
ChargeType	The charge code associated, if a charge was assessed for processing the payment, such as an ATM fee or late fee.
ChargeDescription	Description corresponding to the ChargeType.

Sample Responses

JSON

{
    "ServerElapsedTime": "00:00:02.9052968",
    "Rows": [
        {
            "Type": "PAYMENT",
            "TransactionType": "DR",
            "Description": "DEP RFD   : FIBILL",
            "TransactionDate": "121223",
            "ReferenceDate": "000000",
            "Amount": "000000500-",
            "ChargeType": "",
            "ChargeDescription": ""
        },
        {
            "Type": "PAYMENT",
            "TransactionType": "BD",
            "Description": "AUTO PAY PAYMENT",
            "TransactionDate": "110920",
            "ReferenceDate": "000000",
            "Amount": "000364296-",
            "ChargeType": "",
            "ChargeDescription": ""
        }
    ],
    "OutputParms": {
        "ErrorCode": "0000",
        "ErrorMessage": ""
    }
}

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/Utilities/000000101/000033028/billing/121224/payments";
    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 Type = row["Type"].ToString();
             string TransactionType = row["TransactionType"].ToString();
             string Description = row["Description"].ToString();
             string TransactionDate = row["TransactionDate"].ToString();
             string ReferenceDate = row["ReferenceDate"].ToString();
             string Amount = row["Amount"].ToString();
             string ChargeType = row["ChargeType"].ToString();
             string ChargeDescription = row["ChargeDescription"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/Utilities/000000101/000033028/billing/121224/payments', 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 GetPaymentDetail
   {
       // 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 GetPaymentDetail()
       {
           //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 GetPaymentDetail 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.GetPaymentDetail

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

<h2>GetPaymentDetail</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetPaymentDetail</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/GetPaymentDetail
public ActionResult GetPaymentDetail()
{
   // Create a new instance of the model to pick up any default values.
   GetPaymentDetail model =  new GetPaymentDetail();

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

// 
// POST: /MyController/GetPaymentDetail
[HttpPost]
public ActionResult GetPaymentDetail(FormCollection collection)
{
   string url = "v2/Naviline/Utilities/{CustomerNumber}/{LocationNumber}/billing/{BillDate}/payments";
   // 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", "GetPaymentDetail");
       return View("Error", info);
   }
}