(JavaScript) Xero Get Payroll Employees

Download Xero employees information

Note: This example requires Chilkat v11.0.0 or greater.

For more information, see https://developer.xero.com/documentation/payroll-api/employees

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var http = new CkHttp();

var jsonToken = new CkJsonObject();
success = jsonToken.LoadFile("qa_data/tokens/xero-access-token.json");
if (success == false) {
    console.log(jsonToken.LastErrorText);
    return;
}

http.AuthToken = jsonToken.StringOf("access_token");

// Replace the value here with an actual tenant ID obtained from this example:
// Get Xero Tenant IDs
http.SetRequestHeader("Xero-tenant-id","83299b9e-5747-4a14-a18a-a6c94f824eb7");

http.Accept = "application/json";

var resp = new CkHttpResponse();
success = http.HttpNoBody("GET","https://api.xero.com/payroll.xro/1.0/Employees",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

console.log("Response Status Code: " + resp.StatusCode);

var json = new CkJsonObject();
json.Load(resp.BodyStr);
json.EmitCompact = false;
console.log(json.Emit());

if (resp.StatusCode !== 200) {
    console.log("Failed.");
    return;
}

// Sample response
// (See the parsing code below..)
// 
// Use the this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// {
//   "Id": "796cae61-a7c3-425b-a621-372ab1f29460",
//   "Status": "OK",
//   "ProviderName": "Chilkat2222",
//   "DateTimeUTC": "\/Date(1587075322768)\/",
//   "Employees": [
//     {
//       "EmployeeID": "f12e3b0b-4b4c-4523-b8c0-f481a07bfd13",
//       "FirstName": "James",
//       "LastName": "Lebron",
//       "Status": "ACTIVE",
//       "Email": "JL@madeup.email.com",
//       "DateOfBirth": "\/Date(492739200000+0000)\/",
//       "Gender": "M",
//       "Phone": "0400-000-123",
//       "Mobile": " 408-230-9732",
//       "StartDate": "\/Date(1548806400000+0000)\/",
//       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
//       "PayrollCalendarID": "2cf6326a-d48b-41bf-bf36-7a73b42dd71b",
//       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
//     },
//     {
//       "EmployeeID": "d9f5979f-1de8-4040-aa1d-f1fdd327f893",
//       "FirstName": "Odette",
//       "LastName": "Garrison",
//       "Status": "ACTIVE",
//       "Email": "ogg@madeup.email.com",
//       "DateOfBirth": "\/Date(390528000000+0000)\/",
//       "Gender": "F",
//       "Phone": "9000 1234",
//       "StartDate": "\/Date(1554422400000+0000)\/",
//       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
//       "PayrollCalendarID": "ec0f2f68-f4d1-4490-af70-78e5d7f5dcbd",
//       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
//     },
//     {
//       "EmployeeID": "22879fb4-d13b-46ed-9c07-e43aba25b576",
//       "FirstName": "Oliver",
//       "LastName": "Gray",
//       "Status": "ACTIVE",
//       "Email": "og@madeup.email.com",
//       "DateOfBirth": "\/Date(94176000000+0000)\/",
//       "Gender": "M",
//       "Phone": "0401 123 456",
//       "StartDate": "\/Date(1562112000000+0000)\/",
//       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
//       "PayrollCalendarID": "2cf6326a-d48b-41bf-bf36-7a73b42dd71b",
//       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
//     },
//     {
//       "EmployeeID": "c4d82c18-b1a9-4b6c-982c-14b45b95c10a",
//       "FirstName": "Sally ",
//       "LastName": "Martin",
//       "Status": "ACTIVE",
//       "Email": "sm@madeup3993.com",
//       "DateOfBirth": "\/Date(659577600000+0000)\/",
//       "Gender": "F",
//       "Phone": "0400 123 456",
//       "StartDate": "\/Date(1577750400000+0000)\/",
//       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
//       "PayrollCalendarID": "2cf6326a-d48b-41bf-bf36-7a73b42dd71b",
//       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
//     },
//     {
//       "EmployeeID": "e1a5eed0-721e-482d-b1f1-0b73506f26fb",
//       "FirstName": "Sonia",
//       "LastName": "Michaels",
//       "Status": "ACTIVE",
//       "Email": "som@madeup3993.com",
//       "DateOfBirth": "\/Date(727660800000+0000)\/",
//       "Gender": "F",
//       "Phone": "02 2345 6789",
//       "Mobile": " ",
//       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
//     },
//     {
//       "EmployeeID": "882587ac-1cfe-4f55-9b37-932b0705cd04",
//       "FirstName": "Tracy",
//       "LastName": "Green",
//       "Status": "ACTIVE",
//       "Email": "tg@madeup.email.com",
//       "DateOfBirth": "\/Date(712886400000+0000)\/",
//       "Gender": "F",
//       "Phone": "0402 123 456",
//       "StartDate": "\/Date(1556755200000+0000)\/",
//       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
//       "PayrollCalendarID": "ec0f2f68-f4d1-4490-af70-78e5d7f5dcbd",
//       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
//     }
//   ]
// }

var EmployeeID;
var FirstName;
var LastName;
var v_Email;
var DateOfBirth;
var Gender;
var Phone;
var Mobile;
var StartDate;
var OrdinaryEarningsRateID;
var PayrollCalendarID;
var UpdatedDateUTC;

var Id = json.StringOf("Id");
var Status = json.StringOf("Status");
var ProviderName = json.StringOf("ProviderName");
var DateTimeUTC = json.StringOf("DateTimeUTC");
var i = 0;
var count_i = json.SizeOfArray("Employees");
while (i < count_i) {
    json.I = i;
    EmployeeID = json.StringOf("Employees[i].EmployeeID");
    FirstName = json.StringOf("Employees[i].FirstName");
    LastName = json.StringOf("Employees[i].LastName");
    Status = json.StringOf("Employees[i].Status");
    v_Email = json.StringOf("Employees[i].Email");
    DateOfBirth = json.StringOf("Employees[i].DateOfBirth");
    Gender = json.StringOf("Employees[i].Gender");
    Phone = json.StringOf("Employees[i].Phone");
    Mobile = json.StringOf("Employees[i].Mobile");
    StartDate = json.StringOf("Employees[i].StartDate");
    OrdinaryEarningsRateID = json.StringOf("Employees[i].OrdinaryEarningsRateID");
    PayrollCalendarID = json.StringOf("Employees[i].PayrollCalendarID");
    UpdatedDateUTC = json.StringOf("Employees[i].UpdatedDateUTC");
    i = i+1;
}