Method GetHoursTypeCodeTable

Summary

Get the hours type code table information

Remarks

Excludes any rows where active flag is equal to “I” (inactive)

Excludes any rows where hours type code has been excluded in the “Hours Type Codes” area of the “Time and attendance filters” function in the NaviLine Payroll application

Requires

Input Parameters

NameTypeLengthDescription
None No input parameters to pass

Example

GET http://localhost/FusionServices/v3/Naviline/Payroll/HoursTypeCodeTable

Return Values

NameDescription
ErrorCode Error Code
ErrorDescription Error Description
HOURSTYPECODE Hours type code
HOURSTYPEDESC Hours type description
HOURSELEMENT Hours element (numeric)
HOURSOBJECT Hours object (numeric)
PERCENTOFHOURLYRATE Percentage of hourly rate (numeric)
FIXEDAMOUNTPERHOUR Fixed amount per hour (numeric)
HOURSTYPECLASS Hours type class Values: SB=Standard base, OT=Overtime, XX=Other, PH=Premium hours, CE=Compensatory time earned, CP=Compensatory time premium
DOLLARAMOUNTONLYFLAG Dollar amount only Values: N=No, Y=Yes
INCLUDEINFLSAOTCALC Include in FLSA overtime calculation Values: N=Not included, A=Amount, Q=Quantity, B=Both
TAXAMTATTWENTYPCT Tax amount at supplemental rate Values: N= No, Y=Yes
ACCRUALEARNFACTOR Accrual earn factor (numeric) – factor to multiply hours by
STATERETIREMENTCLASS State retirement class
PREMIUMHOURSCODE Premium hours code
MAXUSABLEPERYEAR Maximum quantity usable per year (numeric)
TYPEYEARMAXUSABLE Type of year for maximum usable Values: A=Annual, F=Fiscal, BLANK=No maximum
MANDATORYDATEFLAG Mandatory date entry Values: N=No, Y=Yes
EXCLUDEFROMTIMESHTS Non-display to user Values: N=No, Y=Yes
SUMMARIZEHISTORY Summarize history
HOUREXPENSEACCOUNT Hour expense account
CONVERTTOCODEONCHECK Code to display on check
HOURCODESHIFT Shift/additional rate Values: BLANK=1st, 2=2nd, 3=3rd, 4=4th, A=Additional rate
FAMILYMEDLEAVEACT Family medical leave act Values: N=No, Y=Yes
ACTIVEFLAG Active flag Values:
INCLUDEINRETROPAY Include in retro pay calculation Values: N=No, Y=Yes

Error Details

Error CodeError Message
00000 Success
00001 Error = Invalid environment parameters
Other SQL state for SQL error

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/Payroll/HoursTypeCodeTable";
    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 HOURSTYPECODE = row["HOURSTYPECODE"].ToString();
             string HOURSTYPEDESC = row["HOURSTYPEDESC"].ToString();
             string HOURSELEMENT = row["HOURSELEMENT"].ToString();
             string HOURSOBJECT = row["HOURSOBJECT"].ToString();
             string PERCENTOFHOURLYRATE = row["PERCENTOFHOURLYRATE"].ToString();
             string FIXEDAMOUNTPERHOUR = row["FIXEDAMOUNTPERHOUR"].ToString();
             string HOURSTYPECLASS = row["HOURSTYPECLASS"].ToString();
             string DOLLARAMOUNTONLYFLAG = row["DOLLARAMOUNTONLYFLAG"].ToString();
             string INCLUDEINFLSAOTCALC = row["INCLUDEINFLSAOTCALC"].ToString();
             string TAXAMTATTWENTYPCT = row["TAXAMTATTWENTYPCT"].ToString();
             string ACCRUALEARNFACTOR = row["ACCRUALEARNFACTOR"].ToString();
             string STATERETIREMENTCLASS = row["STATERETIREMENTCLASS"].ToString();
             string PREMIUMHOURSCODE = row["PREMIUMHOURSCODE"].ToString();
             string MAXUSABLEPERYEAR = row["MAXUSABLEPERYEAR"].ToString();
             string TYPEYEARMAXUSABLE = row["TYPEYEARMAXUSABLE"].ToString();
             string MANDATORYDATEFLAG = row["MANDATORYDATEFLAG"].ToString();
             string EXCLUDEFROMTIMESHTS = row["EXCLUDEFROMTIMESHTS"].ToString();
             string SUMMARIZEHISTORY = row["SUMMARIZEHISTORY"].ToString();
             string HOUREXPENSEACCOUNT = row["HOUREXPENSEACCOUNT"].ToString();
             string CONVERTTOCODEONCHECK = row["CONVERTTOCODEONCHECK"].ToString();
             string HOURCODESHIFT = row["HOURCODESHIFT"].ToString();
             string FAMILYMEDLEAVEACT = row["FAMILYMEDLEAVEACT"].ToString();
             string ACTIVEFLAG = row["ACTIVEFLAG"].ToString();
             string INCLUDEINRETROPAY = row["INCLUDEINRETROPAY"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/Payroll/HoursTypeCodeTable', 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 GetHoursTypeCodeTable
   {
       // Add property for each input param in order to map a field to it
       public GetHoursTypeCodeTable()
       {
           //Set any defaults here
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the GetHoursTypeCodeTable 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.GetHoursTypeCodeTable

@{
   ViewBag.Title = "GetHoursTypeCodeTable";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/Payroll/HoursTypeCodeTable";
}

<h2>GetHoursTypeCodeTable</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetHoursTypeCodeTable</legend>
       <div class="editor-label">Use the fields below to change the values and resubmit.</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/GetHoursTypeCodeTable
public ActionResult GetHoursTypeCodeTable()
{
   // Create a new instance of the model to pick up any default values.
   GetHoursTypeCodeTable model =  new GetHoursTypeCodeTable();

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

// 
// POST: /MyController/GetHoursTypeCodeTable
[HttpPost]
public ActionResult GetHoursTypeCodeTable(FormCollection collection)
{
   string url = "v3/Naviline/Payroll/HoursTypeCodeTable";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();

   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", "GetHoursTypeCodeTable");
       return View("Error", info);
   }
}