Documentation

Introduction

First retrieve a token:

C# Example

string Authenticate()
{
    string token = null;
    if (String.IsNullOrEmpty(username) || String.IsNullOrEmpty(password) || String.IsNullOrEmpty(companyID))
    {
        return "Credentials missing";
    }

    FormUrlEncodedContent content = new FormUrlEncodedContent(new[]
    {
        new KeyValuePair
            ("grant_type", "password"),
        new KeyValuePair
            ("companyId", companyID),
        new KeyValuePair
             ("username", username),
        new KeyValuePair
    ("password", password)
    });
    
    var baseURL = "{{BASE_URL}}/token";
    var request = new HttpRequestMessage(HttpMethod.Post, baseURL);
    request.Content = content;

    HttpResponseMessage response = client.PostAsync(baseURL, content).Result;
    if (response.IsSuccessStatusCode)
    {
    Task<Object>
    res = response.Content.ReadAsAsync<Object>()
    Console.WriteLine("Auth result: " + res);
    Console.WriteLine("Auth result type: " + res.GetType());
    Console.WriteLine("Auth result string: " + res.Result);

    Newtonsoft.Json.Linq.JObject jObj = (Newtonsoft.Json.Linq.JObject)res.Result;
    //get the ticjket out of the json object returned
    token = jObj.GetValue("access_token").ToString();
    Console.WriteLine("Auth token: " + token);
    }
    else
    {
    Console.WriteLine("Auth Was not successful: " + response.StatusCode);
    output.Text = output.Text + "\r\nAuth Was not successful: " + response.StatusCode;
    }

    response.Dispose();
    return token;
    }

Javascript JQuery Example

var settings = {
    "url": "{{BASE_URL}}/token",
    "method": "POST",
    "timeout": 0,
    "headers": {
        "Content-Type": "application/x-www-form-urlencoded"
    },
    "data": {
        "grant_type": "password",
        "companyId": "companyid goes here",
        "username": "username goes here",
        "password": "password goes here"
    }
};

$.ajax(settings).done(function (response) {
    console.log(response);
});

PHP Example

    $curl = curl_init();

    curl_setopt_array($curl, array(
    CURLOPT_URL => '%7B%7BBASE_URL%7D%7D/token',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => 'grant_type=password&companyId=COMPANY_ID&username=USERNAME&password=PASSWORD',
    CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
    ),
    ));

    $response = curl_exec($curl);

    curl_close($curl);
    echo $response;

The returned token may then be passed in the header of all following requests:

authorization: Bearer {token}

Absence

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Absence/{employeeNo}	Get a list of all absences for an employee
GET api/Absence/{employeeNo}/{startDate}	Get a specific absence for an employee. The key is the StartDate
PUT api/Absence/{employeeNo}	Add an Absence to an Employee
POST api/Absence/{employeeNo}/{startDate}	Update an Absence for an Employee. The key for updates is the StartDate
DELETE api/Absence/{employeeNo}/{startDate}	Remove an absence from an Employee. An absence can be deleted only if it has not been paid. The key is the start date.
POST api/Absence	No documentation available.

AbsenceExt

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/AbsenceExt/{employeeNo}	Get a list of all absences for an employee
GET api/AbsenceExt/{employeeNo}/{startDate}	Get a specific absence for an employee. The key is the StartDate
PUT api/AbsenceExt/{employeeNo}	Add an Absence to an Employee
POST api/AbsenceExt/{employeeNo}/{startDate}	Update an Absence for an Employee. The key for updates is the StartDate
DELETE api/AbsenceExt/{employeeNo}/{startDate}	Remove an absence from an Employee. An absence can be deleted only if it has not been paid. The key is the start date.
POST api/AbsenceExt	No documentation available.

Address

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Address/{employeeNo}	Get the employee's current address. The key is the Employee No
PUT api/Address/{employeeNo}	Add an employee's address
POST api/Address/{employeeNo}	Update an employee's address The key is the Employee No
POST api/Address	No documentation available.

Adjustment

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Adjustment/{employeeNo}	Get a list of all adjustments for an employee
GET api/Adjustment/{employeeNo}/{externalId}	Get a specific adjustment for an employee.
PUT api/Adjustment/{employeeNo}	Add an adjustment to an Employee
POST api/Adjustment/{employeeNo}	Update an Adjustment for an Employee.
DELETE api/Adjustment/{employeeNo}/{externalId}	Remove an Adjustment from an Employee. An adjustment can be deleted only if it has not been paid.
POST api/Adjustment	No documentation available.

Bank

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Bank/{employeeNo}/{sortCode}/{accountNumber}	Get a specific Bank record for an employee. The key is the sort code and account number
PUT api/Bank/{employeeNo}	Add a Bank to an Employee
POST api/Bank/{employeeNo}/{sortCode}/{accountNumber}	Update a Bank for an Employee. The key for updates is the previous sort code and account number
DELETE api/Bank/{employeeNo}/{sortCode}/{accountNumber}	Remove a Bank from an Employee.
POST api/Bank	No documentation available.

Base

API	Description
POST api/Base	No documentation available.

Company

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Company/GetAllPayElements	Get all pay elements on the given company
GET api/Company/Lookup/{description}	Get a list of records for the given lookup description
POST api/Company/Lookup/{description}/{value}	Add a new record for the given lookup description
GET api/Company/MethodOfPayment	Get a list of methods of payment
POST api/Company/UpdateEmployeeRates	Update employee rates by Company
POST api/Company	No documentation available.

Deduction

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Deduction/{employeeNo}	Get a list of all deductions for an employee
GET api/Deduction/{employeeNo}/{payElement}/{startDate}	Get a specific deduction for an employee. The key is the PayElement and the StartDate
GET api/Deduction/{employeeNo}/available	Get a list of all payment pay elements available to an employee
PUT api/Deduction/{employeeNo}	Add a deduction to an Employee
POST api/Deduction/Update/{employeeNo}	Update a Deduction for an Employee. The key for updates is the Pay Element and the Start Date
POST api/Deduction/{employeeNo}/{payElement}/{startDate}	Update a Deduction for an Employee. The key for updates is the Pay Element and the Start Date
POST api/Deduction/{employeeNo}/{payElement}/{startDate}/{recordID}	Update a Deduction for an Employee. Uses the record ID, along with Start Date and Pay Element as the key.
POST api/Deduction/Delete/{employeeNo}	Remove an Deduction from an Employee. A deduction can only be deleted if it has never been paid. The start date and the pay element must be specified
DELETE api/Deduction/{employeeNo}/{payElement}/{startDate}	Remove an Deduction from an Employee. A deduction can only be deleted if it has never been paid. The start date and the pay element must be specified
POST api/Deduction	No documentation available.

Department

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Department/{employeeNo}	Get a list of all departments for an employee
GET api/Department/{employeeNo}/{startDate}	Get a specific department record for an employee. The key is the StartDate
PUT api/Department/{employeeNo}	Add a department to an Employee
POST api/Department/{employeeNo}/{startDate}	Update a Department for an Employee. The key for updates is the Start Date
POST api/Department	No documentation available.

EmpBasic

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
POST api/EmpBasic/Email/{employeeNo}	Update employee's email address
POST api/EmpBasic/MethodOfPayment/{employeeNo}	Update employee's method of payment
POST api/EmpBasic	No documentation available.

ExternalImport

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
POST api/ExternalImport	No documentation available.

ExternalImportMessage

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
POST api/ExternalImportMessage	No documentation available.

HolidayScheme

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/HolidayScheme/{employeeNo}	Get a list of all holiday scheme details for an employee
GET api/HolidayScheme/{employeeNo}/{schemeName}/{effectiveDate}	Get specific employee holiday scheme details for an employee. The key is the SchemeName and EffectiveDate
GET api/HolidayScheme/Current/{employeeNo}	Get the employees current holiday scheme
GET api/HolidayScheme/available	Get a list of all holiday schemes available to an employee
PUT api/HolidayScheme/{employeeNo}	Add holiday scheme details to an Employee
POST api/HolidayScheme/{employeeNo}/{schemeName}/{effectiveDate}	Update a holiday scheme for an Employee. The key for updates is the SchemeName and EffectiveDate
DELETE api/HolidayScheme/{employeeNo}/{schemeName}/{effectiveDate}	Remove holiday scheme details from an Employee. A holiday Scheme may be deleted if it is the current record and has not been committed against a previous period. The key is the SchemeName and EffectiveDate.
POST api/HolidayScheme	No documentation available.

Import

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
PUT api/Import/{importType}	Import data. Types are defined per company.
POST api/Import/CustomImport/Upload	Upload a file to the custom importer
GET api/Import/CustomImport/Ready/{date}	Get all uploaded files that are ready to be imported after date (optional)
POST api/Import/CustomImport/StartImport/{guid}/{payroll}	Kicks off the import process - returns whether the import was STARTED successfully, not the outcome.
GET api/Import/CustomImport/Get/{importGUID}	Gets all information about a custom import
GET api/Import/CustomImport/GetMessages/{importGUID}	Gets all [error] messages related to an import
POST api/Import/CustomImport/ImportAll	Upload a file to the custom importer
POST api/Import	No documentation available.

Job

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Job/{employeeNo}	Get a list of all job details for an employee
GET api/Job/{employeeNo}/{startDate}	Get specific job details for an employee. The key is the StartDate
PUT api/Job/{employeeNo}	Add job details to an Employee
POST api/Job/{employeeNo}/{startDate}	Update a Job for an Employee. The key for updates is the StartDate
DELETE api/Job/{employeeNo}/{startDate}	Remove job details from an Employee. A job may be deleted unless it is the first job for the employee. The key is the start date.
POST api/Job	No documentation available.

Leaver

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
PUT api/Leaver/{employeeNo}	Add Employee Leaver
POST api/Leaver	No documentation available.

P60

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/P60?employeeNo={employeeNo}&taxYear={taxYear}	Get an employees P60
POST api/P60	No documentation available.

PayDetail

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
POST api/PayDetail	No documentation available.

Payment

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Payment/{employeeNo}	Get a list of all payments for an employee
POST api/Payment/Get/{employeeNo}	Get a specific payment for an employee. The key is the PayElement and the StartDate from the request body
GET api/Payment/{employeeNo}/{payElement}/{startDate}	Get a specific payment for an employee. The key is the PayElement and the StartDate
GET api/Payment/{employeeNo}/available	Get a list of all payment pay elements available to an employee
GET api/Payment/{employeeNo}/availableSalarySacrifice	Get a list of all payment pay elements available to an employee
PUT api/Payment/{employeeNo}	Add a payment to an Employee
POST api/Payment/Update/{employeeNo}	Update a Payment for an Employee. The key for updates is the Pay Element and the Start Date
POST api/Payment/{employeeNo}/{payElement}/{startDate}	Update a Payment for an Employee. The key for updates is the Pay Element and the Start Date
POST api/Payment/{employeeNo}/{payElement}/{startDate}/{recordID}	Update a payment for an employee. Uses the record ID along with the Pay Element and Start Date for the key.
POST api/Payment/Delete/{employeeNo}	Remove a Payment from an Employee. A payment can only be deleted if it has never been paid. The start date and the pay element must be specified
DELETE api/Payment/{employeeNo}/{payElement}/{startDate}	Remove a Payment from an Employee. A payment can only be deleted if it has never been paid. The start date and the pay element must be specified
POST api/Payment	No documentation available.

Payroll

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Payroll?payrollNo={payrollNo}	Get the pay periods for the given payroll upto the current period
POST api/Payroll	No documentation available.

Payslips

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Payslips?employeeNo={employeeNo}	Get an employees payslips
GET api/Payslips?employeeNo={employeeNo}&payPeriod={payPeriod}	Get an employees payslip
GET api/Payslips?payPeriod={payPeriod}&payrollNo={payrollNo}	Get all payslips in a period
POST api/Payslips	No documentation available.

Pension

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Pension/{employeeNo}	Get a list of all pensions for an employee
GET api/Pension/{employeeNo}/{schemeName}/{joiningDate}	Get a specific pension for an employee. The key is the Pension Scheme and the Joining Date
GET api/Pension/schemes	Get a list of all pension schemes for a company.
GET api/Pension/{employeeNo}/available	Get a list of all pension schemes available to an employee
PUT api/Pension/{employeeNo}	Add a Pension Scheme to an Employee
POST api/Pension/{employeeNo}/{schemeName}/{joiningDate}	Update a Pension Scheme for an Employee. The key for updates is the PensionScheme and the JoiningDate
DELETE api/Pension/{employeeNo}/{schemeName}/{joiningDate}	Remove a Pension Scheme from an Employee. A pension can be deleted only if it has never been used. The key for delete is the PensionScheme and the JoiningDate
POST api/Pension	No documentation available.

Person

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/Person/available	Get a list of all employee numbers
GET api/Person/{employeeNo}	Get a specific employee. The key is the Employee No
POST api/Person	Add an employee
POST api/Person/{employeeNo}	Update an Employee The key is the Employee No
DELETE api/Person/{employeeNo}	Soft delete an Employee. A employee can only be soft deleted if they are a starter

Reinstate

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
PUT api/Reinstate/{employeeNo}	Reinstate an employee
POST api/Reinstate	No documentation available.

Report

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
POST api/Report/GetReport?reportName={reportName}&exportType={exportType}	Download reports
GET api/Report	Get a list of reports
POST api/Report	No documentation available.

SicknessScheme

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/SicknessScheme/{employeeNo}	Get a list of all sickness scheme details for an employee
GET api/SicknessScheme/{employeeNo}/{schemeName}/{effectiveDate}	Get specific employee sickness scheme details for an employee. The key is the SchemeName and EffectiveDate
GET api/SicknessScheme/available	Get a list of all Sickness schemes available to an employee
PUT api/SicknessScheme/{employeeNo}	Add sickness scheme details to an Employee
POST api/SicknessScheme/{employeeNo}/{schemeName}/{effectiveDate}	Update a sickness scheme for an Employee. The key for updates is the SchemeName and Effective Date
DELETE api/SicknessScheme/{employeeNo}/{schemeName}/{effectiveDate}	Remove sickness scheme details from an Employee. A Sickness Scheme may be deleted if it is the current record and has not been committed against a previous period. The key is the SchemeName and EffectiveDate.
POST api/SicknessScheme	No documentation available.

SSPSchedule

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/SSPSchedule/{employeeNo}	Get a list of all schedules for an employee
GET api/SSPSchedule/{employeeNo}/{startDate}	Get a specific SSPSchedule for an employee. The key is the ScheduleName and the StartDate
PUT api/SSPSchedule/{employeeNo}	Add a SSP schedule to an Employee
POST api/SSPSchedule/Update/{employeeNo}	Update a SSPSchedule for an Employee. The key for updates is the Start Date
POST api/SSPSchedule/{employeeNo}/{startDate}	Update a SSPSchedule for an Employee. The key for updates is the Start Date
POST api/SSPSchedule/{employeeNo}/{startDate}/{recordID}	Update a SSP Schedule for an Employee. Uses the record ID and with Start Date as the key.
POST api/SSPSchedule/Delete/{employeeNo}	Remove an SSP Schedule from an Employee.
DELETE api/SSPSchedule/{employeeNo}/{startDate}	Remove an SSP Schedule from an Employee.
POST api/SSPSchedule	No documentation available.

Timesheet

RESTful controller that handles timesheet actions.

API	Description
DELETE api/Timesheets/{timesheetReference}	Delete the timesheet with the supplied reference. This will delete all entries of a timesheet.
POST api/Timesheet	No documentation available.

WorkSchedule

Requires authorization, must have token in the header in the following format: authorization: Bearer {token}

API	Description
GET api/WorkSchedule/{employeeNo}	Get a list of all schedules for an employee
GET api/WorkSchedule/{employeeNo}/{startDate}	Get a specific WorkSchedule for an employee. The key is the ScheduleName and the StartDate
PUT api/WorkSchedule/{employeeNo}	Add a work schedule to an Employee
POST api/WorkSchedule/Update/{employeeNo}	Update a WorkSchedule for an Employee. The key for updates is the Start Date
POST api/WorkSchedule/{employeeNo}/{startDate}	Update a WorkSchedule for an Employee. The key for updates is the Start Date
POST api/WorkSchedule/{employeeNo}/{startDate}/{recordID}	Update a Work Schedule for an Employee. Uses the record ID and with Start Date as the key.
POST api/WorkSchedule/Delete/{employeeNo}	Remove an Work Schedule from an Employee.
DELETE api/WorkSchedule/{employeeNo}/{startDate}	Remove an Work Schedule from an Employee.
POST api/WorkSchedule	No documentation available.