Contents

AllPay Logo

JSON API MANUAL

General Information

Getting Help

If you are stuck or have questions at any point please feel free to send us an email at APISupport@alliancepayroll.com. You may also call in to (281) 875-1818 and ask for Rest API Support.

A note about integrations

If you are integrating another system with AllPay, please let us know. We want to document the integration on our end so that we can provide better support to our clients who may one day experience trouble or have a question about the integration. Please contact our Director of Integrations and Vendor Management, Jessi Cowart by emailing JCowart@alliancepayroll.com.

Type of API

This is a JSON API, all operations are sent through the POST HTTP verb. Authentication is sent in each request in the request body in an "authorization" JSON object. Note that a SOAP version of this API is also available, please visit https://api2.hralliance.net for more information.

Endpoint

https://api2.hralliance.net/AllPayDataRest.svc/JSON

Company Access

By default all companies in AllPay have API access disabled. In order to use the API for your company you need to enable API access.
Enable API access by going to the Company » Security » Security Settings page. Change the API Access to your desired setting.
Example of the Security Settings page in AllPay

API Token

In order to use the API you must have an API token. After enabling API access for your company you will be able to request an API token to be emailed to you by pressing then "Reset API Token" button from the "Settings" link at the top of AllPay in the "Profile" tab. In general each call to the API must pass an AuthHeader that passes credentials for accessing the API, use your APIToken in the AuthHeader by appending it to the end of your password (without any spaces or delimiter in between).
Example of the Security Profile page where you request your API token

Common Object Types

These types are used throughout the API.

Authorization

  • requestExpiration: expiration date and time of the current request, must be no more than 6 minutes in the future but should be after the current date and time
  • [USERNAME]: your AllPay Username
  • [PASSWORD+TOKEN]: your AllPay password concatenated to the token provided by AllPay. To receive an API Token, first log in to your AllPay account, go to the Settings » Profile and press the "Reset API Token" button. Your API Token will then be sent to you via email.
  • userType: indicates the type of user making the request, currently only '0' is supported.
Example:
{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }

QueryOptions

  • batchSize - the number of records to retrieve.
  • startRecord - the first record in the set to retrieve (zero based).
  • queryIdentifier - not used at this time.
Example:
{batchSize: 50, startRecord: 0, queryIdentifier: ''}

RestRecord

The RestRecord object is a wrapper around data objects that help the API to identify the object type.
  • _objectType: the type of object.
  • entity: the data object (such as an employee record or rate of pay record, see the Object Reference below for a list of all data objects).
Example:
{ "_objectType": "EDed", "entity": { "isNew": false, "specifiedSelectFields": "co,id,dcode,calcCode,tabled,units,rate,amount,startDate,endDate,goal,paidTowardsGoal,frequency,lastDate,annualMaximum,minimum,maximum,agency,miscInfo,arrear,guidfield,lastChange,lastChangeUser,cc1,cc2,cc3,cc4,cc5,jobcode", "co": null, "id": null, "dcode": null, "calcCode": null, "tabled": false, "units": 0, "rate": 0, "amount": 0, "startDate": "2019-11-19T00:00:00", "endDate": "2100-12-31T00:00:00", "goal": 0, "paidTowardsGoal": 0, "frequency": null, "lastDate": null, "annualMaximum": 0, "minimum": 0, "maximum": 0, "agency": null, "miscInfo": null, "arrear": 0, "guidfield": "f6b26a70-9d1c-4e3d-a8f0-8b50b5383331", "lastChange": "2019-11-19T13:52:23", "lastChangeUser": "", "cc1": null, "cc2": null, "cc3": null, "cc4": null, "cc5": null, "jobcode": null } }

RestResponse

  • ok: returns true if the request was successfully completed, else it returns false.
  • payload: stores the result of the REST API request. It is an implicit variable, that could contain any type of data.
  • message: error message if the request fails.
Examples:
{"ok": true, "payload": "https://www.hralliance.net", "message": "Any error messages would show up here for an ok: false response."}
{"ok": true, "payload": {"records":[ {"_objectType": "CLicenseType", "entity": { "isNew": false, "specifiedSelectFields": "co,licensetype", "co": null, "licensetype": null } }, {"_objectType": "CLicenseType", "entity": { "isNew": false, "specifiedSelectFields": "co,licensetype", "co": null, "licensetype": null } }, { "_objectType": "CLicenseType", "entity": { "isNew": false, "specifiedSelectFields": "co,licensetype", "co": null, "licensetype": null } } ], "recordCount":3, "fieldsToPopulate":"co,licensetype", "objectType":"CLicenseType" }, "message":null }

Object Reference

Below are all the options for the types of objects that can be consumed (loaded, edited, and deleted) through the API. These objects are used as a parameter, or in the return type of many of API Calls.
  1. Select the object from the dropdown list.
  2. Click the 'Get Object Definition' button.
  3. Note: When you get an object definition below, the example JSON provided in this document for all of the Load, Save, and Delete methods will change to show the selected type.

Request Builder

Use the inputs below to construct a rest request. When you choose the JSON Method you want to call the Request Body text area will pre-fill with a template body for that method.
Note that for the Load, Save, and Delete operations, the example loaded will populate with whatever type you have loaded in the Object Reference section above.

Note: Pressing submit will execute the request on the production endpoint, proceed with care.

Response


Method Documentation

Load (EDed)

The Load method allows you to query and retrieve data stored in the database, only the fields specified in the "fieldsToPopulate" parameter will be returned in the results, other fields will not be serialized or show up at all in the response. Note that the "LoadFullObject" method is just like this method but will write to the response all the fields that were not specified for returned object with null or default values.

Parameters

  • authorization - an authorization object.
  • objectType - a string representing the type of object you want to load - eg. "EInfo" or "CEmpStatus".
  • fieldsToPopulate - a csv string containing the names of the fields to populate and return in the resulting objects.
  • sortOrder - a valid SQL sort order clause based on the object being populated.
  • filter - a valid SQL where clause based on the object being populated.
  • queryOptions - a queryOptions object that describes the number of records to retrieve and the starting record.

Response Payload

A RestResponse whose payload is an array of RestRecord objects.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/load

Example Body

{ "authorization":{ "requestExpiration":"2019-11-19T20:08:44.903Z", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "objectType":"EDed", "fieldsToPopulate":"co,id,dcode,calcCode,rate,amount,startDate,endDate", "filter":"co='Demo'", "sortOrder":"id", "queryOptions":{ "batchSize":2, "startRecord":0, "queryIdentifier":null } }

RESPONSE

Example Body

{ ok: true, payload: { records: [ { _objectType: "EDed", entity: { co: "Demo", id: " 1", dcode: "32", calcCode: "%", rate: 0, amount: 0, startDate: "2013-01-14T00:00:00", endDate: "2019-10-08T00:00:00" } }, { _objectType: "EDed", entity: { co: "Demo", id: " 1", dcode: "401k", calcCode: "", rate: 234, amount: 0, startDate: "2013-01-14T00:00:00", endDate: "2019-10-08T00:00:00" } } ], recordCount: 2, fieldsToPopulate: "co,id,dcode,calcCode,rate,amount,startDate,endDate", objectType: "EDed" }, message: null }

LoadFullObject (EDed)

The LoadFullObject method retrieves an array of Rest Record.
This method allows to query the AllPay Objects, returning the entire object.

Parameters

  • authorization - an authorization object.
  • objectType - a string representing the type of object you want to load - eg. "EInfo" or "CEmpStatus".
  • fieldsToPopulate - a csv string containing the names of the fields to populate in the resulting objects.
  • sortOrder - a valid SQL sort order clause based on the object being populated.
  • filter - a valid SQL where clause based on the object being populated.
  • queryOptions - a queryOptions object that describes the number of records to retrieve and the starting record.

Response Payload

An array of Rest Record objects.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/loadfullobject

Example Body

{ "authorization":{ "requestExpiration":"2019-11-19T20:13:11.872Z", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "objectType":"EDed", "fieldsToPopulate": "co,id,dcode,calcCode,rate,amount,startDate,endDate", "filter":"co='Demo'", "sortOrder":"id", "queryOptions":{ "batchSize":3, "startRecord":0, "queryIdentifier":null } }

RESPONSE

Example Body

{ ok: true, payload: { records: [ { _objectType: "EDed", entity: { primaryKey: { fieldValue: "6e8d4eab-bc93-4093-9874-260fe1985d39", originalValue: "6e8d4eab-bc93-4093-9874-260fe1985d39", name: "guidfield" }, tableName: "EDed", co: "Demo", id: " 1", dcode: "32", calcCode: "%", tabled: false, units: 0, rate: 0, amount: 0, startDate: "2013-01-14T00:00:00", endDate: "2019-10-08T00:00:00", goal: 0, paidTowardsGoal: 0, frequency: null, lastDate: "0001-01-01T00:00:00", annualMaximum: 0, minimum: 0, maximum: 0, agency: null, miscInfo: null, arrear: 0, guidfield: "6e8d4eab-bc93-4093-9874-260fe1985d39", lastChange: "0001-01-01T00:00:00", lastChangeUser: null, cc1: null, cc2: null, cc3: null, cc4: null, cc5: null, jobcode: null, specifiedSelectFields: "co,id,dcode,calcCode,rate,amount,startDate,endDate,guidfield", isNew: false } }, { _objectType: "EDed", entity: { primaryKey: { fieldValue: "8bf7c940-5b27-4abe-9a07-887d1b36fc3d", originalValue: "8bf7c940-5b27-4abe-9a07-887d1b36fc3d", name: "guidfield" }, tableName: "EDed", co: "Demo", id: " 1", dcode: "401k", calcCode: "", tabled: false, units: 0, rate: 234, amount: 0, startDate: "2013-01-14T00:00:00", endDate: "2019-10-08T00:00:00", goal: 0, paidTowardsGoal: 0, frequency: null, lastDate: "0001-01-01T00:00:00", annualMaximum: 0, minimum: 0, maximum: 0, agency: null, miscInfo: null, arrear: 0, guidfield: "8bf7c940-5b27-4abe-9a07-887d1b36fc3d", lastChange: "0001-01-01T00:00:00", lastChangeUser: null, cc1: null, cc2: null, cc3: null, cc4: null, cc5: null, jobcode: null, specifiedSelectFields: "co,id,dcode,calcCode,rate,amount,startDate,endDate,guidfield", isNew: false } }, { _objectType: "EDed", entity: { primaryKey: { fieldValue: "1454d377-4390-4b9b-9f45-5bf393d62a87", originalValue: "1454d377-4390-4b9b-9f45-5bf393d62a87", name: "guidfield" }, tableName: "EDed", co: "Demo", id: " 1", dcode: "A\R", calcCode: "", tabled: false, units: 0, rate: 34, amount: 0, startDate: "2013-01-14T00:00:00", endDate: "2019-10-08T00:00:00", goal: 0, paidTowardsGoal: 0, frequency: null, lastDate: "0001-01-01T00:00:00", annualMaximum: 0, minimum: 0, maximum: 0, agency: null, miscInfo: null, arrear: 0, guidfield: "1454d377-4390-4b9b-9f45-5bf393d62a87", lastChange: "0001-01-01T00:00:00", lastChangeUser: null, cc1: null, cc2: null, cc3: null, cc4: null, cc5: null, jobcode: null, specifiedSelectFields: "co,id,dcode,calcCode,rate,amount,startDate,endDate,guidfield", isNew: false } } ], recordCount: 3, queryIdentifier: null, lastError: null, fieldsToPopulate: "co,id,dcode,calcCode,rate,amount,startDate,endDate", objectType: "EDed" }, message: null }

Save (EInfo)

The save method saves the object passed in the request to the database. This method can result in adding a record or updating a record depending on whether the 'isNew' property of the passed object is true or false. Note that all records are located for updating according to their primary key (normally the field called guidfield).
Important: Do not forget to populate the "specifiedSelectFields" property of the entity you are saving, the system will only update/add the fields that you list in this property

Parameters

Response Payload

An object describing the results of the save operation. If the object failed data validation or a database level error occurs during the save these results are passed back in the 'ok' and 'lastError' properties of the result.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/Save

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "record": { "_objectType":"EInfo", "entity":{ "guidfield":"e681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77381", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } } }

RESPONSE

Example Body

{ "ok":true, "payload":{ "ok":true, "lastError":"", "primaryKey":"e681ce2d-591a-4cde-856f-4966f8cf7418" }, "message":null }

SaveMultiple (EInfo)

The SaveMultiple method saves multiple objects passed in the request as an array to the database. Note that all records are located for updating according to their primary key (normally the field called guidfield).
Important: Do not forget to populate the "specifiedSelectFields" property of the entity you are saving, the system will only update/add the fields that you list in this property

Parameters

Response Payload

An array of objects describing the results of the save operation. If the object failed data validation or a database level error occurs during the save these results are passed back in the 'ok' and 'lastError' properties of the result.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/SaveMultiple

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "records":[ { "_objectType":"EInfo", "entity":{ "guidfield":"e681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77381", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"f681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77382", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"g681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77383", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } } ] }

RESPONSE

Example Body

{ "ok":true, "payload":[ { "ok":true, "lastError":"", "primaryKey":"e681ce2d-591a-4cde-856f-4966f8cf7418" }, { "ok":true, "lastError":"", "primaryKey":"f681ce2d-591a-4cde-856f-4966f8cf7418" }, { "ok":true, "lastError":"", "primaryKey":"g681ce2d-591a-4cde-856f-4966f8cf7418" } ], "message":null }

SaveMultipleInTransaction (EInfo)

The SaveMultiple method saves the objects passed in the request to the database in a single transaction. If any item fails to save the transaction is rolled back without attempting to commit it. If all items pass validation and save then the transaction is commited. If the commit fails or any item fails to save pre-commit then every returned action result will have an ok status of false along with a message indicating the error. Note that all records are located for updating according to their primary key (normally the field called guidfield).
Important: Do not forget to populate the "specifiedSelectFields" property of the entity you are saving, the system will only update/add the fields that you list in this property

Parameters

Response Payload

An array of objects describing the results of the save operation. If the object failed data validation or a database level error occurs during the save these results are passed back in the 'ok' and 'lastError' properties of the result.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/SaveMultipleInTransaction

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "records":[ { "_objectType":"EInfo", "entity":{ "guidfield":"e681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77381", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"f681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77382", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"g681ce2d-591a-4cde-856f-4966f8cf7418", "address1":"9110 Forest XING", "address2":"", "city":"The Woodlands", "state":"TX", "zip":"77383", "specifiedSelectFields":"address1,address2,city,state,zip", "isNew":false } } ] }

RESPONSE

Example Body

{ "ok":true, "payload":[ { "ok":true, "lastError":"", "primaryKey":"e681ce2d-591a-4cde-856f-4966f8cf7418" }, { "ok":true, "lastError":"", "primaryKey":"f681ce2d-591a-4cde-856f-4966f8cf7418" }, { "ok":true, "lastError":"", "primaryKey":"g681ce2d-591a-4cde-856f-4966f8cf7418" } ], "message":null }

Delete (EInfo)

The delete operation deletes the obect passed in the request to the database. Note that all records are located for deletion according to their primary key (normally the field called guidfield).

Parameters

  • authorization - an authorization object.
  • record - a Rest Record object. Note that only the primary key of the object needs to be sent (you can send more fields if desired but they will be ignored).

Response Payload

An object describing the results of the delete operation. If the object failed data validation or a database level error occurs during the delete these results are passed back in the 'ok' and 'lastError' properties of the result.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/Delete

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "record":{ "_objectType":"EInfo", "entity":{ "guidfield":"7250ce06-f49b-4b1d-b04d-05ebd38b43a9", "specifiedSelectFields":null, "isNew":false } } }

RESPONSE

Example Body

{ "ok":true, "payload":{ "ok":true, "lastError":"", "primaryKey":"7250ce06-f49b-4b1d-b04d-05ebd38b43a9" }, "message":null }

DeleteMultiple (EInfo)

The DeleteMultiple operation deletes the objects passed in the request for to database. Note that all records are located for deletion according to their primary key (normally the field called guidfield).j

Parameters

  • authorization - an authorization object.
  • records - a list of Rest Record objects. . Note that only the primary key of each object needs to be sent (you can send more fields if desired but they will be ignored).

Response Payload

An array of objects describing the results of the delete operation. If the object failed data validation or a database level error occurs during the delete these results are passed back in the 'ok' and 'lastError' properties of the result.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/DeleteMultiple

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "records":[ { "_objectType":"EInfo", "entity":{ "guidfield":"276e1e7d-474c-449d-9ecc-90d2170f71ee", "specifiedSelectFields":null, "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"376e1e7d-474c-449d-9ecc-90d2170f71ee", "specifiedSelectFields":null, "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"476e1e7d-474c-449d-9ecc-90d2170f71ee", "specifiedSelectFields":null, "isNew":false } } ] }

RESPONSE

Example Body

{ "ok":true, "payload":[ { "ok":true, "lastError":"", "primaryKey":"276e1e7d-474c-449d-9ecc-90d2170f71ee" }, { "ok":true, "lastError":"", "primaryKey":"376e1e7d-474c-449d-9ecc-90d2170f71ee" }, { "ok":true, "lastError":"", "primaryKey":"476e1e7d-474c-449d-9ecc-90d2170f71ee" } ], "message":null }

DeleteMultipleInTransaction (EInfo)

The DeleteMultiple operation deletes the objects passed in the request for to database in a single transaction. If any item fails to delete the transaction is rolled back without attempting to commit it. If all items pass validation and delete then the transaction is committed. If the commit fails or any item fails to delete pre-commit then every returned action result will have an ok status of false along with a message indicating the error. Note that all records are located for deletion according to their primary key (normally the field called guidfield).

Parameters

  • authorization - an authorization object.
  • records - a list of Rest Record objects. Note that only the primary key of each object needs to be sent (you can send more fields if desired but they will be ignored).

Response Payload

An array of objects describing the results of the delete operation. If the object failed data validation or a database level error occurs during the delete these results are passed back in the 'ok' and 'lastError' properties of the result.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/DeleteMultipleInTransaction

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "records":[ { "_objectType":"EInfo", "entity":{ "guidfield":"276e1e7d-474c-449d-9ecc-90d2170f71ee", "specifiedSelectFields":null, "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"376e1e7d-474c-449d-9ecc-90d2170f71ee", "specifiedSelectFields":null, "isNew":false } }, { "_objectType":"EInfo", "entity":{ "guidfield":"476e1e7d-474c-449d-9ecc-90d2170f71ee", "specifiedSelectFields":null, "isNew":false } } ] }

RESPONSE

Example Body

{ "ok":true, "payload":[ { "ok":true, "lastError":"", "primaryKey":"276e1e7d-474c-449d-9ecc-90d2170f71ee" }, { "ok":true, "lastError":"", "primaryKey":"376e1e7d-474c-449d-9ecc-90d2170f71ee" }, { "ok":true, "lastError":"", "primaryKey":"476e1e7d-474c-449d-9ecc-90d2170f71ee" } ], "message":null }

CreateEmployee

The CreateEmployee method is a helper method for setting up a new employee. It takes care of many scenarios such as checking if the employee is a rehire and if so then ending previous taxes, direct deposits, and rates, and also setting up status change records which are important for proper ACA tracking.

Parameters

  • authorization - an authorization object.
  • eInfo - a Rest Record object that contains an EInfo object, the employee to add to the company.
  • fitw - a Rest Record object that contains an ETax object for the FITW tax.
  • sitw - a Rest Record object that contains an ETax object for the SITW tax.
  • eRates -a list of Rest Record objects that contain the ERates objects of the employee (one rate must be present with a rateCode of "Base")
  • eDirDeps -a list of Rest Record objects that contain the EDirDeps objects of the employee.
  • acaStatus - the ACAStatus of the employee. Can be one of: "In Initial Measurement Period", "Variable Hour - Eligible", "Variable Hour - Ineligible", "Full Time - Eligible", "DoNotChange" (DoNotChange is allowed for rehires only). This is a required field.

Response Paylaod

The employee that was created during the save operation.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/CreateEmployee

Example Body

{"authorization":{"loginToken":"","password":"","requestExpiration":"2019-11-21T20:23:22.609Z","userName":"","userType":0},"eInfo":{"_objectType":"EInfo","entity":{"co":"Demo","firstName":"John","lastName":"Doe","ssn":"546-98-7832","cc1":"500","cc2":"100","cc3":"A","hireDate":"2019-11-21T20:18:22.609Z"}},"fitw":{"_objectType":"ETax","entity":{"tcode":"FITW","filingStatus":"M","exemptions":2,"exemptions2":0,"overrideTaxCalc":false,"defaultTax":true,"additionalAmount":0,"additionalPercentage":0,"lowWageCredit":false,"priority":50}},"sitw":{"_objectType":"ETax","entity":{"tcode":"TX","filingStatus":"N/A","exemptions":0,"exemptions2":0,"overrideTaxCalc":false,"defaultTax":true,"additionalAmount":0,"additionalPercentage":0,"lowWageCredit":false,"priority":100}},"eRates":[{"_objectType":"ERate","entity":{"rateCode":"Base","rate":8.5,"co":"Demo"}}],"eDirDeps":[{"_objectType":"EDirDep","entity":{"transit":"111993776","amount":100,"checking":true,"account":"123456","amountCode":"%"}}],"acaStatus":"Full Time - Eligible"}

RESPONSE

Example Body

{"ok":true,"payload":{ _objectType: "EInfo", entity: { isNew: false, specifiedSelectFields: "co,id,lastName,firstName,middleName,address1,address2,city,state,zip,county,country,ssn,birthDate,sex,empStatus,empType,payGroup,hireDate,rehireDate,adjSeniorityDate,termDate,termReason,cc1,cc2,cc3,cc4,cc5,wcc,clock,defaultHours,payFrequency,autoPay,jobCode,tipped,guidfield,lastChange,lastChangeUser,password,salutation,surname,nickname,priorLastName,homePhone,ethnicity,maritalStatus,disabilityDesc,veteranDesc,smoker,positionCode,positionInfoLocked,title,eeoClass,flsaOTExempt,workPhone,workPhoneExt,mailStop,emailAddress,taxForm,pension,statutory,deceased,deferredComp,legalRep,domesticEmpl,seasonal,i9Verified,i9Reverify,citizenship,visaType,visaExpiration,unionCode,unionDate,unionInitFees,unionDues,supervisorID,supervisorName,lastRaiseDate,lastRaiseAmount,lastRaiseReason,nextRaiseDate,lastReviewDate,lastReviewRating,nextReviewDate,user1,user2,user3,user4,user5,user6,user7,user8,miscCheck1,miscCheck2,miscCheck3,miscCheck4,miscCheck5,ee401kDeferral,ee401kCalc,ee401kContinue,ee401kEligibleDate,ee401kStatus,ee401kSuspendDate,er401kMatch,highComp,owner,ownerPercent,ownerRelated,ownerSSN,memo,showMemo,workState,officer,wageType,family,probation,distributionCodes,cellPhone,ratePer,payGrade", co: null, id: null, lastName: null, firstName: null, middleName: "", address1: null, address2: null, city: null, state: null, zip: null, county: null, country: null, ssn: null, birthDate: null, sex: null, empStatus: "A", empType: null, payGroup: null, hireDate: null, rehireDate: null, adjSeniorityDate: null, termDate: null, termReason: null, cc1: null, cc2: null, cc3: null, cc4: null, cc5: null, wcc: null, clock: null, defaultHours: 0, payFrequency: null, autoPay: null, jobCode: null, tipped: null, guidfield: "bf394853-a8ef-4849-9b9f-06f69d08cb83", lastChange: "2019-11-21T15:59:36", lastChangeUser: "", password: null, salutation: null, surname: null, nickname: null, priorLastName: null, homePhone: null, ethnicity: null, maritalStatus: null, disabilityDesc: null, veteranDesc: null, smoker: false, positionCode: null, positionInfoLocked: false, title: null, eeoClass: null, flsaOTExempt: false, workPhone: null, workPhoneExt: null, mailStop: null, emailAddress: null, taxForm: "W2", pension: false, statutory: false, deceased: false, deferredComp: false, legalRep: false, domesticEmpl: false, seasonal: false, i9Verified: false, i9Reverify: null, citizenship: null, visaType: null, visaExpiration: null, unionCode: null, unionDate: null, unionInitFees: false, unionDues: false, supervisorID: null, supervisorName: null, lastRaiseDate: null, lastRaiseAmount: null, lastRaiseReason: null, nextRaiseDate: null, lastReviewDate: null, lastReviewRating: null, nextReviewDate: null, user1: null, user2: null, user3: null, user4: null, user5: null, user6: null, user7: null, user8: null, miscCheck1: false, miscCheck2: false, miscCheck3: false, miscCheck4: false, miscCheck5: false, ee401kDeferral: null, ee401kCalc: null, ee401kContinue: false, ee401kEligibleDate: null, ee401kStatus: null, ee401kSuspendDate: null, er401kMatch: null, highComp: false, owner: false, ownerPercent: null, ownerRelated: false, ownerSSN: null, memo: null, showMemo: false, workState: null, officer: false, wageType: "W", family: false, probation: false, distributionCodes: null, cellPhone: null, ratePer: null, payGrade: null } },"message":""}

BaseURL_AllPay

The main AllPay web site e.g. https://www.hralliance.net/

Parameters

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/baseurl_allpay

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 } }

RESPONSE

Example Body

{ "ok":true, "payload":"https://www.hralliance.net", "message":null }

BaseURL_MyPay

The employee self service portal e.g. https://www.hralliance.net/ee

Parameters

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/baseurl_mypay

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 } }

RESPONSE

Example Body

{ "ok":true, "payload":"https://www.hralliance.net/ee/", "message":null }

BaseUrl_Onboarding

The onboarding portal e.g. https://www.hralliance.net/Portal - Note that you must append /?PortalURL to the end where PortalURL is the value stored in the desired CPortal record.

Parameters

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/baseurl_onboarding

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 } }

RESPONSE

Example Body

{ "ok":true, "payload":"https://www.hralliance.net/Portal", "message":null }

BaseURL_ApplicantTracking

The applicant tracking portal e.g. https://www.hralliance.net/Apply - Note that you must append /?ApplicantURL to the end where ApplicantURL is the value stored in the desired CAppl record.

Parameters

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/baseurl_applicanttracking

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 } }

RESPONSE

Example Body

{ "ok":true, "payload":"https://www.hralliance.net/Apply", "message":null }

getDatabaseTime

The getDatabaseTime method retrieves the current time of the database server.

Parameters

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/getDatabaseTime

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 } }

RESPONSE

Example Body

{ "ok":true, "payload":"2019-11-07T13:36:00", "message":null }

getLastChangeTime

The getLastChangeTime method retrieves the date and time of the latest change that is available to be pulled via the ESyncedChanges and CSyncedChanged methods. Note that AllPay uses a two stage logging system, all change logs available via the API pull from the second (final) logging stage. If you are recording a synchronization time for changes into your local data store you should only mark changes complete through this setting. You should retrieve this value before calling ESyncedChanges and/or CSyncedChanges and only pull change through this value.

Parameters

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/getlastchangetime

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 }, "co":"Demo", "dbType":1 }
dbType 1 = HR/Benefits/Onboarding data
dbType 2 = Payroll data

RESPONSE

Example Body

{ "ok":true, "payload":"2018-05-29T10:41:54", "message":null }

TransferToEmployee

This method transfers an onboarding user and associated data into an employee object.

Parameters

  • authorization - an authorization object.
  • EOnboard - a Rest Record object that contains an EOnboard record.
  • EmployeeId - the employee id to use.
  • mergeWithRehireEmployee - a Rest Record object that contains an EInfoMini record representing the existing employee that the passed EOnboard should merge with. If this is a new employee pass null here.

Response Payload

An object that describes the result of the operation.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/TransferToEmployee

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "EOnboard":{ "_objectType":"EOnboard", "entity":{ "co":"Demo", "becameEmpId":"UNIV90", "oId":"WWYDQJ", "guidfield":"bb7c162e-3cbb-4820-8965-c0dc22a4a836", "lastChange":"2019-11-07T14:58:17.46", "lastChangeUser":"Karen", "CPortalGuid":"36c905aa-3a6a-4a43-b192-2e18dd07bb04", "password":"15000:v7xndWA/N6herkm1+ZKRhyg9vvEPu86WD4FPC05iqNeJbLyluxiRs5B3i3JBarQB", "complete":true, "emailAddress":"Karen@alliancepayroll.com", "expirationDate":"2019-11-06T00:00:00", "xferErrors":null, "userName":"bra1", "lastName":"Brancaccio", "firstName":"Alice", "ssn":"111-11-111", "initialPassword":null, "electronicSignature":"AB", "percentComplete":100.0, "testAccount":false, "existingEmpGuid":"0772781b-1faf-48a2-bc49-5602590f4abb", "applicantGuid":null, "dateSubmitted":"2019-09-30T13:00:15.62", "referrer":null, "lastEmailSent":"2019-09-30T12:56:46.15", "emailSendCount":1, "passwordSalt":"eb1e3c23-6da9-4ebb-b794-5039ab82b1bd", "convertToEmpDate":"2019-11-07T14:58:17.46", "smsCode":null, "specifiedSelectFields":"co,becameEmpId,oId,guidfield,lastChange,lastChangeUser,CPortalGuid,password,complete,emailAddress,expirationDate,xferErrors,userName,lastName,firstName,ssn,initialPassword,electronicSignature,percentComplete,testAccount,existingEmpGuid,applicantGuid,dateSubmitted,referrer,lastEmailSent,emailSendCount,passwordSalt,convertToEmpDate,smsCode", "co": null, "becameEmpId": " 33", "isNew":false } }, "EmployeeId":"UNIV90", "MergeWithRehireEmployee":{ "_objectType":"EInfoMini", "entity":{ "co":"Demo", "id":"UNIV90", "lastName":"Brancaccio", "firstName":"Alice", "middleName":"Esther", "state":"NY", "ssn":"641-44-6214", "empStatus":"A", "hireDate":"2017-07-17T00:00:00", "termDate":"2012-08-08T00:00:00", "rehireDate":"2016-01-01T00:00:00", "cc1":"000002", "cc2":"069", "cc3":"CC3", "cc4":"", "cc5":"", "clock":"641446214", "guidfield":"0772781b-1faf-48a2-bc49-5602590f4abb", "taxForm":"W2", "specifiedSelectFields":"co,id,lastName,firstName,middleName,state,ssn,empStatus,hireDate,termDate,rehireDate,cc1,cc2,cc3,cc4,cc5,clock,guidfield,taxForm", "isNew":false } } }

RESPONSE

Example Body

{ "ok":true, "payload":{ "ok":true, "submittedForWorkflowApproval":false, "EOnboardingGuid":null, "errorMessages":"" }, "message":null }

TransferEmployeeToOnboarding

This method transfers an existing employee into an onboarding user for the purposes of re-onboarding them.

Parameters

  • authorization - an authorization object.
  • Employee - a Rest Record object that contains an EInfo record representing the existing employee who should be re-onboarded.
  • Portal - a Rest Record object that contains an CPortal record representing the onboarding portal the employee will use.
  • userName - the desired user name for the user, if available it will be used, if not a new one will be created for you.

Response Payload

An object that describes the result of the operation.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/TransferEmployeeToOnboarding

Example Body

{ "authorization":{ "requestExpiration":"2019-11-16T08:45:59.4871875-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "Employee":{ "_objectType":"EInfo", "entity":{ "co":"Demo", "id":"UNIW66", "lastName":"Balaji", "firstName":"Test7", "middleName":"", "address1":"", "address2":"", "city":"Aurora", "state":"CO", "zip":"80011", "county":"", "country":null, "ssn":"633-13-2245", "birthDate":null, "sex":null, "empStatus":"A", "empType":"TPT", "payGroup":"D1", "hireDate":"2017-07-17T00:00:00", "rehireDate":null, "adjSeniorityDate":null, "termDate":null, "termReason":"", "cc1":"069", "cc2":"100", "cc3":"", "cc4":null, "cc5":null, "wcc":"8809", "clock":null, "defaultHours":40.000000, "payFrequency":"W", "autoPay":"Salary", "jobCode":null, "tipped":"D", "guidfield":"232225fa-11d2-47b8-ada6-c2b29263b512", "lastChange":"2019-02-12T11:27:06.473", "lastChangeUser":"Microsoft SQL Server Management Studio - Query", "salutation":null, "surname":null, "nickname":null, "priorLastName":null, "homePhone":null, "ethnicity":null, "maritalStatus":null, "disabilityDesc":null, "veteranDesc":null, "smoker":false, "positionCode":"DRIVER", "positionInfoLocked":false, "title":"DRIVER", "eeoClass":"", "flsaOTExempt":false, "workPhone":null, "workPhoneExt":null, "mailStop":null, "emailAddress":"Karen@alliancepayroll.com", "taxForm":"W2", "pension":false, "statutory":false, "deceased":false, "deferredComp":false, "legalRep":false, "domesticEmpl":false, "seasonal":false, "i9Verified":true, "i9Reverify":null, "citizenship":null, "visaType":null, "visaExpiration":null, "unionCode":"999", "unionDate":"2016-11-14T00:00:00", "unionInitFees":false, "unionDues":false, "supervisorID":null, "supervisorName":null, "lastRaiseDate":null, "lastRaiseAmount":0.0, "lastRaiseReason":null, "nextRaiseDate":null, "lastReviewDate":null, "lastReviewRating":null, "nextReviewDate":null, "user1":"1121", "user2":null, "user3":null, "user4":null, "user5":null, "user6":null, "user7":null, "user8":null, "miscCheck1":false, "miscCheck2":false, "miscCheck3":false, "miscCheck4":false, "miscCheck5":false, "ee401kDeferral":0.0, "ee401kCalc":null, "ee401kContinue":false, "ee401kEligibleDate":null, "ee401kStatus":null, "ee401kSuspendDate":null, "er401kMatch":0.0, "highComp":false, "owner":false, "ownerPercent":0, "ownerRelated":false, "ownerSSN":null, "memo":null, "showMemo":false, "workState":"TX", "officer":false, "wageType":"W", "family":false, "probation":false, "distributionCodes":null, "cellPhone":null, "ratePer":null, "payGrade":null, "specifiedSelectFields":"co,id,lastName,firstName,middleName,state,ssn,empStatus,hireDate,termDate,rehireDate,cc1,cc2,cc3,cc4,cc5,clock,guidfield,taxForm", "isNew":false } }, "Portal":{ "_objectType":"CPortal", "entity":{ "co":"Demo", "guidfield":"36c905aa-3a6a-4a43-b192-2e18dd07bb04", "lastChange":"2019-09-30T10:19:28.37", "lastChangeUser":"Karen", "portalName":"Test", "portalAddress":"Test", "collectI9":false, "verifySSN":false, "collectW4":false, "allowESSSignup":false, "active":true, "collectEmergency":false, "collectDirDeps":false, "allowPayCards":true, "payCardTransit":"", "requireDirDepOrPaycard":true, "includeCodeOfEthics":false, "includeNonDisclosure":false, "includeNonCompete":false, "includeTaxCreditSurvey":false, "includeConditionsOfEmployment":false, "includeFinalInstructions":false, "codeOfEthicsHTML":null, "nonDisclosureHTML":null, "nonCompeteHTML":null, "conditionsOfEmploymentHTML":null, "finalInstructionsHTML":null, "electronicSignatureHTML":null, "includePayCardStatement":false, "payCardStatementHTML":null, "codeOfEthicsSigType":"Electronic Signature", "nonDisclosureSigType":"Electronic Signature", "nonCompeteSigType":"Electronic Signature", "conditionsOfEmploymentSigType":"Electronic Signature", "finalInstructionsSigType":"Electronic Signature", "payCardSigType":"Electronic Signature", "printCodeOfEthics":true, "printNonDisclosure":true, "printNonCompete":true, "printConditionsOfEmployment":true, "printFinalInstructions":true, "printPayCardStatement":true, "printElectronicSignature":true, "logoFileName":"", "i9SigType":"Electronic Signature", "w4SigType":"Electronic Signature", "emergencySigType":"Electronic Signature", "dirDepSigType":"Electronic Signature", "taxCreditSurveySigType":"Electronic Signature", "checkRehireEligible":true, "rehireEligibleCoList":"Demo,Paul", "enrollmentEmail":null, "includeDependents":false, "dependentsSigType":"Electronic Signature", "collectEmploymentHist":false, "employmentHistSigType":"Electronic Signature", "employmentHistHTML":null, "xferUserEmailTo":"Home Email", "requireMyPaySignup":false, "mypaySignUpHTML":null, "translationLanguages":"", "collectStateW4":false, "stateW4SigType":"Electronic Signature", "skipDirDepPrenote":false, "allowMultipleDirDeps":true, "taxCreditTPAAuthHTML":"", "requireDDOnConv":false, "basicInfoEmailType":"Work Email", "includeEducation":false, "educationSigType":"Electronic Signature", "welcomeEmailSubject":"Welcome Aboard {FirstName}!", "sendReminderEmails":false, "autoReOnboardRehires":false, "collectW9":false, "w9SigType":"Electronic Signature", "rehireEligibleCoSet":"Randy", "onboardSMSConf":false, "specifiedSelectFields":null, "isNew":false } }, "userName":"AllPayUsernameTest" }

RESPONSE

Example Body

{ "ok":true, "payload":{ "ok":true, "submittedForWorkflowApproval":false, "EOnboardingGuid":"724ef629-02fc-4905-8e56-b8aa3ec0bf4f", "errorMessages":"" }, "message":null }

TransferApplicantToOnboarding

This method transfers an applicant employee into an onboarding user.

Parameters

  • authorization - an authorization object.
  • Applicant - a Rest Record object that contains an Applicant being onboarded.
  • Portal - a Rest Record object that contains an CPortal record representing the onboarding portal the employee will use.
  • userName - the desired user name for the user, if available it will be used, if not a new one will be created for you.
  • ExtraTransferFields - an EOnboard.ExtraTransferFields object containing fields used to override the department, location, email address, rates of pay, ssn or other information while creating the onboarding user. If you do not want to override or provide additional rates this parameter may be null

Response Payload

An object that describes the result of the operation.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/TransferApplicantToOnboarding

EOnboard.ExtraTransferFields

This object is used to transfer customized overrides and pay rates while either creating a new onboarding user or transferring an applicant into an onboarding user.
  • cc1 - cost center #1
  • cc2 - cost center #2
  • cc3 - cost center #3
  • cc4 - cost center #4
  • cc5 - cost center #5
  • ssn
  • firstName
  • lastName
  • emailAddress
  • payFrequency
  • supervisorId
  • hireDate - a nullable DateTime
  • payRates - a list of EPortalRate items

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "Applicant":{ "_objectType":"EAppl", "entity":{ "co":"Demo", "lastChange":"2019-11-11T14:52:07.797", "lastChangeUser":"AllPay", "guidfield":"08dc5a7f-094a-46c2-822a-aaaa0042f507", "applicantToken":"DU57IBIKB4OJP3EJ97JXVJHM74HXJBJ5PWJUTBOZP4", "applicantId":3321, "CApplGuid":"ae36d037-5795-433b-bece-a99e00fb5cfd", "positionGuid":"1b463fbe-9b19-496b-a740-aa5000f3e04d", "locationGuid":"d235f8b2-4ccd-494c-b04b-aa8c00a0a772", "appBeginDate":"2019-08-15T04:03:47.01", "disqualified":true, "userName":null, "password":null, "appSubmitDate":"2019-08-15T04:03:47.01", "submitted":true, "finalScore":0.00, "electronicSignatureInfo":null, "applicantGuid":"08dc5a7f-094a-46c2-822a-aaaa0042f507", "onboardingGuid":"11659467-185f-4168-b17b-bf80ecf256f9", "disqualifyReasonCode":null, "notes":"Manually Added by Karen on 8/15/2019 4:03:47 AM", "assessmentScore":null, "assessmentResult":null, "assessmentLink":null, "referrer":"Manually Added", "disqualifyDate":"2019-08-15T04:03:58.253", "onboardDate":"2019-11-11T14:52:07.757", "dqReason":"Does not meet legal age requirement", "specifiedSelectFields":"co,lastChange,lastChangeUser,guidfield,applicantToken,applicantId,CApplGuid,positionGuid,locationGuid,appBeginDate,disqualified,userName,password,appSubmitDate,submitted,finalScore,electronicSignatureInfo,applicantGuid,onboardingGuid,disqualifyReasonCode,notes,assessmentScore,assessmentResult,assessmentLink,referrer,disqualifyDate,onboardDate,dqReason", "isNew":false } }, "Portal":{ "_objectType":"CPortal", "entity":{ "co":"Demo", "guidfield":"36c905aa-3a6a-4a43-b192-2e18dd07bb04", "lastChange":"2019-09-30T10:19:28.37", "lastChangeUser":"Karen", "portalName":"TestKaren", "portalAddress":"TestKaren", "collectI9":false, "verifySSN":false, "collectW4":false, "allowESSSignup":false, "active":true, "collectEmergency":false, "collectDirDeps":false, "allowPayCards":true, "payCardTransit":"", "requireDirDepOrPaycard":true, "includeCodeOfEthics":false, "includeNonDisclosure":false, "includeNonCompete":false, "includeTaxCreditSurvey":false, "includeConditionsOfEmployment":false, "includeFinalInstructions":false, "codeOfEthicsHTML":null, "nonDisclosureHTML":null, "nonCompeteHTML":null, "conditionsOfEmploymentHTML":null, "finalInstructionsHTML":null, "electronicSignatureHTML":null, "includePayCardStatement":false, "payCardStatementHTML":null, "codeOfEthicsSigType":"Electronic Signature", "nonDisclosureSigType":"Electronic Signature", "nonCompeteSigType":"Electronic Signature", "conditionsOfEmploymentSigType":"Electronic Signature", "finalInstructionsSigType":"Electronic Signature", "payCardSigType":"Electronic Signature", "printCodeOfEthics":true, "printNonDisclosure":true, "printNonCompete":true, "printConditionsOfEmployment":true, "printFinalInstructions":true, "printPayCardStatement":true, "printElectronicSignature":true, "logoFileName":"", "i9SigType":"Electronic Signature", "w4SigType":"Electronic Signature", "emergencySigType":"Electronic Signature", "dirDepSigType":"Electronic Signature", "taxCreditSurveySigType":"Electronic Signature", "checkRehireEligible":true, "rehireEligibleCoList":"Demo,Paul", "enrollmentEmail":null, "includeDependents":false, "dependentsSigType":"Electronic Signature", "collectEmploymentHist":false, "employmentHistSigType":"Electronic Signature", "employmentHistHTML":null, "xferUserEmailTo":"Home Email", "requireMyPaySignup":false, "mypaySignUpHTML":null, "translationLanguages":"", "collectStateW4":false, "stateW4SigType":"Electronic Signature", "skipDirDepPrenote":false, "allowMultipleDirDeps":true, "taxCreditTPAAuthHTML":"", "requireDDOnConv":false, "basicInfoEmailType":"Work Email", "includeEducation":false, "educationSigType":"Electronic Signature", "welcomeEmailSubject":"Welcome Aboard {FirstName}!", "sendReminderEmails":false, "autoReOnboardRehires":false, "collectW9":false, "w9SigType":"Electronic Signature", "rehireEligibleCoSet":"Randy", "onboardSMSConf":false, "specifiedSelectFields":null, "isNew":false } }, "userName":null, "extraTransferFields":null }

RESPONSE

Example Body

{ "ok":true, "payload":{ "ok":true, "submittedForWorkflowApproval":false, "EOnboardingGuid":"02a20e88-1db3-4860-94bd-bb542697a92b", "errorMessages":"" }, "message":null }

CreateOnboarder

This method creates an onboarder.

Parameters

  • authorization - an authorization object.
  • eo - a Rest Record object that contains an EOnboard record.
  • epi - a Rest Record object that contains a EPortalInfo record.
  • emailNotification - a boolean to notify the onboarder with an email: true to send the email, false to not send the email.

Response Payload

The created EOnboard record.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/CreateOnboarder

Example Body

{ "authorization":{ "requestExpiration":"2019-11-16T09:26:59.3224234-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "eo":{ "_objectType":"EOnboard", "entity":{ "co":"Demo", "becameEmpId":null, "oId":null, "guidfield":"45a69e86-9c19-4ebf-9727-afc5e95bc85f", "lastChange":"2019-11-16T09:21:59.3224234-06:00", "lastChangeUser":"AllPay", "CPortalGuid":"67773897-736d-46c9-8bbc-0e92e50ee70f", "password":null, "complete":false, "emailAddress":"Karen@alliancepayroll.com", "expirationDate":"2019-12-16T09:21:59.3224234-06:00", "xferErrors":null, "userName":null, "lastName":"Miller", "firstName":"Frank", "ssn":null, "initialPassword":null, "electronicSignature":null, "percentComplete":0.0, "testAccount":false, "existingEmpGuid":null, "applicantGuid":null, "dateSubmitted":null, "referrer":null, "lastEmailSent":null, "emailSendCount":0, "passwordSalt":null, "convertToEmpDate":null, "smsCode":null, "specifiedSelectFields":null, "isNew":true } }, "epi":null, "emailNotification":false }

Response

Example Body

{ "ok":true, "payload":{ "primaryKey":{ "fieldValue":"569f8807-4f75-4c20-a70d-678824f30434", "originalValue":"569f8807-4f75-4c20-a70d-678824f30434", "name":"guidfield" }, "tableName":"EOnboard", "co":"Demo", "becameEmpId":"", "oId":"D2NPD4", "guidfield":"569f8807-4f75-4c20-a70d-678824f30434", "lastChange":"2019-11-16T09:21:59", "lastChangeUser":"AllPay", "CPortalGuid":"67773897-736d-46c9-8bbc-0e92e50ee70f", "password":"", "complete":false, "emailAddress":"Karen@alliancepayroll.com", "expirationDate":"2019-12-16T00:00:00", "xferErrors":"", "userName":"MillerFr", "lastName":"Miller", "firstName":"Frank", "ssn":"", "initialPassword":"", "electronicSignature":"", "percentComplete":0.0, "testAccount":false, "existingEmpGuid":null, "applicantGuid":null, "dateSubmitted":null, "referrer":"", "lastEmailSent":null, "emailSendCount":0, "passwordSalt":null, "convertToEmpDate":null, "smsCode":"", "specifiedSelectFields":null, "isNew":false }, "message":null }

CreateESSOneTimePassword

Creates a one time login password for the ESelfServe user that is supplied.

Parameters

  • authorization - an authorization object
  • ESSUser - a Rest Record object that contains an ESelfServe record representing the user for whom to generate the one time password.

Response Payload

An array of Rest Record objects that contains HRUserOTP records that will contain the password for the user.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/CreateESSOneTimePassword

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "ESSUser":{ "_objectType":"ESelfServe", "entity":{ "co":"Demo", "id":" 2", "username":"SCody", "password":"", "lastPasswordChange":"2019-03-18T11:45:51", "lastChange":"2019-03-18T11:51:50.247", "lastChangeUser":"SCody", "siteKey":null, "accountStatus":null, "accountStatusDate":"2011-08-04T14:39:54.847", "emailAddress":"Karen@alliancepayroll.com", "preferences":null, "lastLogin":null, "guidfield":"67161450-f39d-45f2-8f79-f61289120650", "newEmail":null, "verfEmailReception":true, "verfIdentity":false, "secChangePassword":true, "secChangeUsername":true, "secChangeSecurityQ":true, "verfEmailCode":null, "verfCookie":null, "secQuestion1":"", "secAnswer1":"••••", "secQuestion2":"", "secAnswer2":"••••", "secQuestion3":"", "secAnswer3":"••••", "controlAccessManually":false, "initialPassword":"", "tempPWExpiration":"2015-09-10T15:09:26", "enrollmentGuid":null, "accountLocked":false, "electronicSig":null, "passwordSalt":"", "commUseEmail":true, "commUseApp":true, "lastMobileLogin":null, "specifiedSelectFields":null, "isNew":false } } }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"HRUserOTP", "entity":{ "primaryKey":{ "fieldValue":"234bd13b-845c-41cb-9003-ab0600de76aa", "originalValue":"234bd13b-845c-41cb-9003-ab0600de76aa", "name":"guidfield" }, "tableName":"HRUserOTP", "guidfield":"234bd13b-845c-41cb-9003-ab0600de76aa", "lastChange":"2019-11-15T13:29:57", "lastChangeUser":"Karen", "otpToken":"3qIX))EEQvC=q;Au0+6*FwiFIM4%%Pg!gz@R8GVxBo01KHNPFn", "otpUsed":false, "userGuid":"67161450-f39d-45f2-8f79-f61289120650", "issueDate":"2019-11-15T13:29:57", "site":"ESS", "specifiedSelectFields":null, "isNew":false } } ], "recordCount":1, "queryIdentifier":null, "lastError":null, "fieldsToPopulate":null, "objectType":null }, "message":null }

CreateOnboardingOneTimePassword

Creates a one time login password for the EOnboard user that is supplied.

Parameters

  • authorization - an authorization object.
  • EOnboard - a Rest Record object that contains an EOnboard record representing the user for whom to generate the one time password.

Response Payload

An array of Rest Record objects that contains HRUserOTP records that will contain the password for the user.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/CreateOnboardingOneTimePassword

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "EOnboard":{ "_objectType":"EOnboard", "entity":{ "co":"Demo", "becameEmpId":"UNIV90", "oId":"WWYDQJ", "guidfield":"bb7c162e-3cbb-4820-8965-c0dc22a4a836", "lastChange":"2019-11-15T11:26:28.47", "lastChangeUser":"Karen", "CPortalGuid":"36c905aa-3a6a-4a43-b192-2e18dd07bb04", "password":"15000:v7xndWA/N6herkm1+ZKRhyg9vvEPu86WD4FPC05iqNeJbLyluxiRs5B3i3JBarQB", "complete":true, "emailAddress":"Karen@alliancepayroll.com", "expirationDate":"2019-11-14T00:00:00", "xferErrors":null, "userName":"bra1", "lastName":"Brancaccio", "firstName":"Alice", "ssn":"641-44-6214", "initialPassword":null, "electronicSignature":"AB", "percentComplete":100.0, "testAccount":false, "existingEmpGuid":"0772781b-1faf-48a2-bc49-5602590f4abb", "applicantGuid":null, "dateSubmitted":"2019-09-30T13:00:15.62", "referrer":null, "lastEmailSent":"2019-09-30T12:56:46.15", "emailSendCount":1, "passwordSalt":"eb1e3c23-6da9-4ebb-b794-5039ab82b1bd", "convertToEmpDate":"2019-11-15T11:26:28.47", "smsCode":null, "specifiedSelectFields":null, "isNew":false } } }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"HRUserOTP", "entity":{ "primaryKey":{ "fieldValue":"35c9ad71-ffab-48c1-aaf2-ab0600df6409", "originalValue":"35c9ad71-ffab-48c1-aaf2-ab0600df6409", "name":"guidfield" }, "tableName":"HRUserOTP", "guidfield":"35c9ad71-ffab-48c1-aaf2-ab0600df6409", "lastChange":"2019-11-15T13:33:20", "lastChangeUser":"Karen", "otpToken":"bScGa_kd*%:=LA#LBh+XC1EU*v$+IFl1G_O@<Eb,MLtf<TT=y", "otpUsed":false, "userGuid":"bb7c162e-3cbb-4820-8965-c0dc22a4a836", "issueDate":"2019-11-15T13:33:20", "site":"Onboarding", "specifiedSelectFields":null, "isNew":false } } ], "recordCount":1, "queryIdentifier":null, "lastError":null, "fieldsToPopulate":null, "objectType":null }, "message":null }

RunReportJob

This method requests AllPay to run a report. Use QueryJob to check the status and then either DownloadJobResult or GetOneTImeDownloadURL to download the results when it is complete.

Parameters

  • authorization - an authorization object.
  • co - the company code to run the report for (note: reports can be run for multiple companies at once, this is the company in which the report resides).
  • reportId - the report id to run. Note that this report must exist in the company or the request will fail.
  • properties - a URL Encoded set of properties that describe additional options, date ranges and company codes to use when running the report. Contact us for details of what to send here for the specific report you are needing to run.

Response Payload

An array of Rest Record objects that contains HRJobQ records describing the job.

Note

Please contact us for assistance generating report properties if you need to pass in properties for the report that are different than the report that is saved on our system in the company specified.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/RunReportJob

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "co":"Demo", "reportId":"EmpList", "properties":"" }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"HRJobQ", "entity":{ "primaryKey":{ "fieldValue":"bb59480d-ffdc-43ef-9fc1-d1de82137951", "originalValue":"bb59480d-ffdc-43ef-9fc1-d1de82137951", "name":"guidfield" }, "tableName":"HRJobQ", "guidfield":"bb59480d-ffdc-43ef-9fc1-d1de82137951", "jobType":"CrystalReport2", "queuedUser":"Karen", "queuedTime":"2019-11-15T13:44:19", "notes":null, "starttime":"0001-01-01T00:00:00", "endtime":"0001-01-01T00:00:00", "processor":null, "props":"", "co":"Demo", "status":"active", "result":null, "createdbyJob":"00000000-0000-0000-0000-000000000000", "priority":50, "identityvalue":0, "outputFile":null, "Description":"Calendar Schedule", "Precedent":null, "userMessage":null, "queuedUserType":"AllPay", "downloadAsFileName":null, "memDiff":null, "specifiedSelectFields":null, "isNew":false } } ], "recordCount":1, "queryIdentifier":null, "lastError":null, "fieldsToPopulate":null, "objectType":null }, "message":null }

RunReportWriterJob

This method requests AllPay to run a report writer report. Use QueryJob to check the status and then either DownloadJobResult or GetOneTImeDownloadURL to download the results when it is complete.

Parameters

  • authorization - an authorization object.
  • co - the company code to run the report for (note: reports can be run for multiple companies at once, this is the company in which the report resides).
  • reportId - the report writer id to run. Note that this report must exist in the company or the request will fail.
  • properties - a URL Encoded set of properties that describe additional options, date ranges and company codes to use when running the report. Contact us for details of what to send here for the specific report you are needing to run.

Response Payload

An array of Rest Record objects that contains HRJobQ records describing the job.

Note

Please contact us for assistance generating report properties if you need to pass in properties for the report that are different than the report that is saved on our system in the company specified.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/RunReportWriterJob

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "co":"Demo", "reportId":"Warnings", "properties":"username=Karen&allowedCompanies=1%2c37236%2c37238%2c38101%2c38102%2c38105%2c38305%2cBitsOfC%2cDemo%2cDemo1%2cHRA%2cKASHTECH%2cPaul%2cPRAVAS%2cRIVICONS%2cVburst&securityFilter=&outputPath=c%3a%5cp4%5cdownloads%5cKaren%5c9U98HJBCFUUJ&reportguid=%7bb53ff3fe-5ef9-4be0-93e7-d6327f8e0d7a%7d" }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"HRJobQ", "entity":{ "primaryKey":{ "fieldValue":"a7409e76-0431-49c8-8287-1b89b9ae5c79", "originalValue":"a7409e76-0431-49c8-8287-1b89b9ae5c79", "name":"guidfield" }, "tableName":"HRJobQ", "guidfield":"a7409e76-0431-49c8-8287-1b89b9ae5c79", "jobType":"RW", "queuedUser":"Karen", "queuedTime":"2019-11-15T13:45:56", "notes":null, "starttime":"0001-01-01T00:00:00", "endtime":"0001-01-01T00:00:00", "processor":null, "props":"username=Karen&allowedCompanies=1%2c37236%2c37238%2c38101%2c38102%2c38105%2c38305%2cBitsOfC%2cDemo%2cDemo1%2cHRA%2cKASHTECH%2cPaul%2cPRAVAS%2cRIVICONS%2cVburst&securityFilter=&outputPath=c%3a%5cp4%5cdownloads%5cKaren%5cH02ZUXNWVFQA&reportguid=%7bf726256f-2bc1-4d5c-8649-dc0934b271bd%7d", "co":"Demo", "status":"active", "result":null, "createdbyJob":"00000000-0000-0000-0000-000000000000", "priority":50, "identityvalue":0, "outputFile":null, "Description":"Warnings via API", "Precedent":null, "userMessage":null, "queuedUserType":null, "downloadAsFileName":null, "memDiff":null, "specifiedSelectFields":null, "isNew":false } } ], "recordCount":1, "queryIdentifier":null, "lastError":null, "fieldsToPopulate":null, "objectType":null }, "message":null }

QueryJob

Reporting and other jobs are run in AllPay asynchronously. The QueryJob method provides a way to check the status of a job. The status field will go from 'active' to 'running' and then when finished to 'done' or possibly 'error'.

Parameters

  • authorization - an authorization object.
  • jobGuidField - the guid of the job whose results should be queried.

Response Payload

An array of Rest Record objects that contains HRJobQ records describing the job.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/QueryJob

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "jobGuidField":"a13f0cb9-71ae-48e9-a435-f244aa2ef92e" }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"HRJobQ", "entity":{ "primaryKey":{ "fieldValue":"a13f0cb9-71ae-48e9-a435-f244aa2ef92e", "originalValue":"a13f0cb9-71ae-48e9-a435-f244aa2ef92e", "name":"guidfield" }, "tableName":"HRJobQ", "guidfield":"a13f0cb9-71ae-48e9-a435-f244aa2ef92e", "jobType":"EMail", "queuedUser":"Karen", "queuedTime":"2019-11-07T14:58:17", "notes":null, "starttime":"2019-11-08T08:59:23", "endtime":"2019-11-08T08:59:24", "processor":"APS-Karen", "props":"DestCo=Demo&RcptType=MyPay&RcptCode=Demo%3aUNIV90&Email=Karen%40alliancepayroll.com&Subject=Self+Service+Enrollment+-+tmer&Body=%3chtml%3e%0a%3ch2%3eWelcome!%3c%2fh2%3e%3cbr%3e++%3ch3%3eYou+are+now+enrolled+in+our+Employee+Self+Service+feature+called+MyPay!%3c%2fh3%3e%3cbr%3e++The+system+provides+secure+and+easy+access+to+your+payroll+and+human+resources+information+online.++A+few+of+the+features+of+the+system+include%3a%3cbr%3e%0a1.+Access+to+your+current+and+previous+check+stubs.%3cbr%3e%0a2.+Ability+to+run+compensation+reports%3cbr%3e%0a3.+Access+to+your+current+payroll+setup%2c+including+information+on+earnings%2c+deductions%2c+taxes+and+direct+deposits.%3cbr%3e%3cbr%3e%0a%0a%3cb%3eAccessing+Your+Account%3c%2fb%3e%3cbr%3e%0aStep+1%3a%3cbr%3e%0aClick+the+link+below+or+enter+the+URL+below+into+your+web+browser%3cbr%3e%0aAddress%3a%09%3ca+href%3d%22https%3a%2f%2fallpay.alliancepayroll.info%2fee%22%3ehttps%3a%2f%2fallpay.alliancepayroll.info%2fee%3c%2fa%3e%3cbr%3e%3cbr%3e%0a%0aStep+2%3a%3cbr%3e%0aEnter+the+following+user+name+and+temporary+password.%3cbr%3e%3cb%3ePlease+note+that+your+password+will+expire+in+2+days%2c+please+log+in+before+that+time.%3c%2fb%3e%3cbr%3e%0aUser+Name%3a+tmer%3cbr%3e%0aPassword%3a+++2k86sn%3cbr%3e%3cbr%3e%0a%0a%0aYou+will+be+prompted+to+verify+your+identity%2c+change+your+user+name+and+password+during+your+initial+log+in+as+well+as+answer+a+few+security+related+questions.++Please+note+that+your+password+must+contain+at+least+6+characters+including+one+letter%2c+and+one+number+or+punctuation.%3cbr%3e%3cbr%3e%0a%0a%0aPlease+direct+questions+and%2for+problems+with+the+web+site+to+your+system+administrator%3a+%3cbr%3e%0aPaul+Fleischman%3cbr%3e%0apaul%40alliancepayroll.com%3cbr%3e%3cbr%3e%0a%0aThank+you%2c%0aAlliance+Payroll%0a%3c%2fhtml%3e&ReplyTo=paul%40alliancepayroll.com", "co":"Demo", "status":"Done", "result":"Sent Via MailGun » Karen@alliancepayroll.com", "createdbyJob":"00000000-0000-0000-0000-000000000000", "priority":45, "identityvalue":443682, "outputFile":"", "Description":"Send Email Self Service Enrollment - tmer", "Precedent":null, "userMessage":"", "queuedUserType":"AllPay", "downloadAsFileName":null, "memDiff":8364032, "specifiedSelectFields":"", "isNew":false } } ], "recordCount":1, "queryIdentifier":null, "lastError":"", "fieldsToPopulate":null, "objectType":null }, "message":null }

AddRelatedTaxes

A special operation contract exists to help set up taxes related to an existing tax code, this is called addRelatedTaxes. The add related tax method is used to set up any taxes that are related to the tax being passed in the request. For instance the FITW tax code has the related taxes SS, SS-R, MED, MED-R, FUTA. Calling addRelatedTaxes with an FITW tax will set up all of these additional taxes. In General for a new hire you should set up FITW and appropriate state income tax code and call addRelatedTaxes for both. However, in cross-state or multi-state scenarios you may not want to call addRelatedTaxes on the state withholding tax.

Parameters

  • authorization - an authorization object.
  • baseTaxEntry - a Rest Record object that contains an ETax record whose related taxes will be set up.

Response Payload

An array of Rest Record objects that contains ETax records.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/addrelatedtaxes

Example Body

{ "authorization":{ "requestExpiration":"2019-11-16T09:38:48.5679565-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "baseTaxEntry":{ "_objectType":"ETax", "entity":{ "co":"Demo", "id":" 7", "tcode":"FITW", "filingStatus":null, "exemptions":0.0, "exemptions2":0.0, "overrideTaxCalc":false, "defaultTax":true, "reciprocal":null, "additionalAmount":0.0, "additionalPercentage":0.0, "lowWageCredit":false, "specialCheckCalc":null, "priority":0, "startDate":"2016-02-10T00:00:00", "endDate":"2100-12-31T00:00:00", "percentofgross":0.0, "guidfield":"355f30ac-5652-41fa-8e05-9540bb3bd8c3", "lastChange":"2019-11-16T09:33:48.6737032-06:00", "lastChangeUser":"AllPay", "addlTaxData1":null, "otherIncomeAmt":null, "otherDeductionAmt":null, "otherCreditAmt":null, "addlTaxOption1":false, "addlTaxOption2":false, "addlTaxOption3":false, "specifiedSelectFields":"co,tcode,id,startdate,enddate,guidfield,filingstatus,exemptions,exemptions2", "isNew":true } } }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"ETax", "entity":{ "primaryKey":{ "fieldValue":"03c059db-dc5f-42df-be9b-35cf30b65542", "originalValue":"03c059db-dc5f-42df-be9b-35cf30b65542", "name":"guidfield" }, "tableName":"ETax", "co":"Demo", "id":" 7", "tcode":"SS", "filingStatus":"N/A", "exemptions":0.0, "exemptions2":0.0, "overrideTaxCalc":false, "defaultTax":true, "reciprocal":null, "additionalAmount":0.0, "additionalPercentage":0.0, "lowWageCredit":false, "specialCheckCalc":null, "priority":40, "startDate":"2016-02-10T00:00:00", "endDate":"2100-12-31T00:00:00", "percentofgross":0.0, "guidfield":"03c059db-dc5f-42df-be9b-35cf30b65542", "lastChange":"2019-11-16T09:33:49", "lastChangeUser":"Karen", "addlTaxData1":null, "otherIncomeAmt":null, "otherDeductionAmt":null, "otherCreditAmt":null, "addlTaxOption1":false, "addlTaxOption2":false, "addlTaxOption3":false, "specifiedSelectFields":"co,id,tcode,startdate,enddate,filingstatus,exemptions,exemptions2,priority", "isNew":false } }, { "_objectType":"ETax", "entity":{ "primaryKey":{ "fieldValue":"05fcd504-c78b-4d44-a3b0-a83635220010", "originalValue":"05fcd504-c78b-4d44-a3b0-a83635220010", "name":"guidfield" }, "tableName":"ETax", "co":"Demo", "id":" 7", "tcode":"SS-R", "filingStatus":"N/A", "exemptions":0.0, "exemptions2":0.0, "overrideTaxCalc":false, "defaultTax":true, "reciprocal":null, "additionalAmount":0.0, "additionalPercentage":0.0, "lowWageCredit":false, "specialCheckCalc":null, "priority":40, "startDate":"2016-02-10T00:00:00", "endDate":"2100-12-31T00:00:00", "percentofgross":0.0, "guidfield":"05fcd504-c78b-4d44-a3b0-a83635220010", "lastChange":"2019-11-16T09:33:49", "lastChangeUser":"Karen", "addlTaxData1":null, "otherIncomeAmt":null, "otherDeductionAmt":null, "otherCreditAmt":null, "addlTaxOption1":false, "addlTaxOption2":false, "addlTaxOption3":false, "specifiedSelectFields":"co,id,tcode,startdate,enddate,filingstatus,exemptions,exemptions2,priority", "isNew":false } }, { "_objectType":"ETax", "entity":{ "primaryKey":{ "fieldValue":"ffdc0176-23f7-45d7-910c-227153cca500", "originalValue":"ffdc0176-23f7-45d7-910c-227153cca500", "name":"guidfield" }, "tableName":"ETax", "co":"Demo", "id":" 7", "tcode":"MED", "filingStatus":"N/A", "exemptions":0.0, "exemptions2":0.0, "overrideTaxCalc":false, "defaultTax":true, "reciprocal":null, "additionalAmount":0.0, "additionalPercentage":0.0, "lowWageCredit":false, "specialCheckCalc":null, "priority":40, "startDate":"2016-02-10T00:00:00", "endDate":"2100-12-31T00:00:00", "percentofgross":0.0, "guidfield":"ffdc0176-23f7-45d7-910c-227153cca500", "lastChange":"2019-11-16T09:33:49", "lastChangeUser":"Karen", "addlTaxData1":null, "otherIncomeAmt":null, "otherDeductionAmt":null, "otherCreditAmt":null, "addlTaxOption1":false, "addlTaxOption2":false, "addlTaxOption3":false, "specifiedSelectFields":"co,id,tcode,startdate,enddate,filingstatus,exemptions,exemptions2,priority", "isNew":false } }, { "_objectType":"ETax", "entity":{ "primaryKey":{ "fieldValue":"2e9101f9-b5dd-42fe-bff6-2738bd1ded3b", "originalValue":"2e9101f9-b5dd-42fe-bff6-2738bd1ded3b", "name":"guidfield" }, "tableName":"ETax", "co":"Demo", "id":" 7", "tcode":"MED-R", "filingStatus":"N/A", "exemptions":0.0, "exemptions2":0.0, "overrideTaxCalc":false, "defaultTax":true, "reciprocal":null, "additionalAmount":0.0, "additionalPercentage":0.0, "lowWageCredit":false, "specialCheckCalc":null, "priority":40, "startDate":"2016-02-10T00:00:00", "endDate":"2100-12-31T00:00:00", "percentofgross":0.0, "guidfield":"2e9101f9-b5dd-42fe-bff6-2738bd1ded3b", "lastChange":"2019-11-16T09:33:49", "lastChangeUser":"Karen", "addlTaxData1":null, "otherIncomeAmt":null, "otherDeductionAmt":null, "otherCreditAmt":null, "addlTaxOption1":false, "addlTaxOption2":false, "addlTaxOption3":false, "specifiedSelectFields":"co,id,tcode,startdate,enddate,filingstatus,exemptions,exemptions2,priority", "isNew":false } }, { "_objectType":"ETax", "entity":{ "primaryKey":{ "fieldValue":"a29c6e63-2b57-4ed1-9226-1507fd512ec2", "originalValue":"a29c6e63-2b57-4ed1-9226-1507fd512ec2", "name":"guidfield" }, "tableName":"ETax", "co":"Demo", "id":" 7", "tcode":"FUTA", "filingStatus":"N/A", "exemptions":0.0, "exemptions2":0.0, "overrideTaxCalc":false, "defaultTax":true, "reciprocal":null, "additionalAmount":0.0, "additionalPercentage":0.0, "lowWageCredit":false, "specialCheckCalc":null, "priority":100, "startDate":"2016-02-10T00:00:00", "endDate":"2100-12-31T00:00:00", "percentofgross":0.0, "guidfield":"a29c6e63-2b57-4ed1-9226-1507fd512ec2", "lastChange":"2019-11-16T09:33:49", "lastChangeUser":"Karen", "addlTaxData1":null, "otherIncomeAmt":null, "otherDeductionAmt":null, "otherCreditAmt":null, "addlTaxOption1":false, "addlTaxOption2":false, "addlTaxOption3":false, "specifiedSelectFields":"co,id,tcode,startdate,enddate,filingstatus,exemptions,exemptions2,priority", "isNew":false } } ], "recordCount":5, "queryIdentifier":null, "lastError":"", "fieldsToPopulate":null, "objectType":null }, "message":null }

GetOneTimeDownloadURL

Retrieves a url that contains a one-time password that can be used to download the results of job. The url can either be used as-is in a get request or the parameters in the query string can be stripped and sent via a post request.

Parameters

  • authorization - an authorization object.
  • jobGuidField - the guid of the job whose results should be downloaded.

Response Payload

A url containing a one-time password.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/GetOneTimeDownloadURL

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "jobGuidField":"a13f0cb9-71ae-48e9-a435-f244aa2ef92e" }

RESPONSE

Example Body

{ "ok":true, "payload":"https://localhost/DownloadOTPJob.aspx?jobid=a13f0cb9-71ae-48e9-a435-f244aa2ef92e&otp=-henIK%3beYAk!VJWSayge.%40TYf%3a%2c*y%3a%3e%5eufqObrGr%2cKzl8lJvOm", "message":null }

GetOneTimeDocumentDownloadURL

Retrieves a URL that contains a one-time password that can be used to download an employee, company or employee photo.

Parameters

  • authorization - an authorization object.
  • docType - an integer describing the type of document to be downloaded (0: EmployeeDocument, 1: CompanyDocument, 2: EmployeePhoto).
  • documentGuid - the guidfield of the document to download.

Response Payload

A url containing a one-time password.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/GetOneTimeDocumentDownloadURL

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "docType":0, "documentGuid":"faaae322-1d2a-4da5-afa6-00473190dcda" }

RESPONSE

Example Body

{ "ok":true, "payload":"https://localhost/DownloadOTPDocument.aspx?documentGuid=faaae322-1d2a-4da5-afa6-00473190dcda&otp=49bfgKlq%23QFvNz%23RRnWz7R!SyEkiImzU-Z%3c5k_bW%3eGkZ%40%3cjO0P&documentType=EDocuments", "message":null }

GetOneTimeDocumentUploadURL

Retrieves a URL that contains a one-time password that can be used to upload an employee, company or employee photo.

Parameters

  • authorization - an authorization object.
  • docType - an integer describing the type of document to be uploaded (0: EmployeeDocument, 1: CompanyDocument, 2: EmployeePhoto).
  • documentGuid - the guidfield of the document to upload.

Response Payload

A url containing a one-time password.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/GetOneTimeDocumentUploadURL

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "docType":0, "documentGuid":"faaae322-1d2a-4da5-afa6-00473190dcda" }

RESPONSE

Example Body

{ "ok":true, "payload":"https://localhost/UploadOTPDocument.aspx?documentGuid=faaae322-1d2a-4da5-afa6-00473190dcda&otp=X%3eWGG%24YJsek!evjnmTI%25i38fTTZ6.ezQ(h%5e%3aUhB!4%25H)BLy*Y%5e&documentType=EDocuments", "message":null }

GetProtoObject

Get the definition of one of the objects of the Allpay system.

Parameters

  • objectType - the type of object requested.

Response Payload

  • json - contains the json structure of a Rest Record that contains the object requested.
  • properties - contains the list of parameters with description of the AllPay object.

REQUEST

URL

Content-Type: application/json POST https://api2.hralliance.net/AllPayRestData.svc/json/GetProtoObject

Example Body

{ "objectType":"EInfo" }

RESPONSE

Example Body

{ "ok":true, "payload":{ "json":{ "_objectType":"EInfo", "entity": { "isNew":false, "specifiedSelectFields":"co,id,lastName,firstName,middleName,address1,address2,city,state,zip,county,country,ssn,birthDate,sex,empStatus,empType,payGroup,hireDate,rehireDate,adjSeniorityDate,termDate,termReason,cc1,cc2,cc3,cc4,cc5,wcc,clock,defaultHours,payFrequency,autoPay,jobCode,tipped,guidfield,lastChange,lastChangeUser,password,salutation,surname,nickname,priorLastName,homePhone,ethnicity,maritalStatus,disabilityDesc,veteranDesc,smoker,positionCode,positionInfoLocked,title,eeoClass,flsaOTExempt,workPhone,workPhoneExt,mailStop,emailAddress,taxForm,pension,statutory,deceased,deferredComp,legalRep,domesticEmpl,seasonal,i9Verified,i9Reverify,citizenship,visaType,visaExpiration,unionCode,unionDate,unionInitFees,unionDues,supervisorID,supervisorName,lastRaiseDate,lastRaiseAmount,lastRaiseReason,nextRaiseDate,lastReviewDate,lastReviewRating,nextReviewDate,user1,user2,user3,user4,user5,user6,user7,user8,miscCheck1,miscCheck2,miscCheck3,miscCheck4,miscCheck5,ee401kDeferral,ee401kCalc,ee401kContinue,ee401kEligibleDate,ee401kStatus,ee401kSuspendDate,er401kMatch,highComp,owner,ownerPercent,ownerRelated,ownerSSN,memo,showMemo,workState,officer,wageType,family,probation,distributionCodes,cellPhone,ratePer,payGrade", "co":null, "id":null, "lastName":null, "firstName":null, "middleName":"", "address1":null, "address2":null, "city":null, "state":null, "zip":null, "county":null, "country":null, "ssn":null, "birthDate":null, "sex":null, "empStatus":"A", "empType":null, "payGroup":null, "hireDate":null, "rehireDate":null, "adjSeniorityDate":null, "termDate":null, "termReason":null, "cc1":null, "cc2":null, "cc3":null, "cc4":null, "cc5":null, "wcc":null, "clock":null, "defaultHours":0.0, "payFrequency":null, "autoPay":null, "jobCode":null, "tipped":null, "guidfield":"f1c3a621-16e6-4fa8-b200-bcd2f733dbab", "lastChange":"2019-11-16T11:06:31", "lastChangeUser":"", "password":null, "salutation":null, "surname":null, "nickname":null, "priorLastName":null, "homePhone":null, "ethnicity":null, "maritalStatus":null, "disabilityDesc":null, "veteranDesc":null, "smoker":false, "positionCode":null, "positionInfoLocked":false, "title":null, "eeoClass":null, "flsaOTExempt":false, "workPhone":null, "workPhoneExt":null, "mailStop":null, "emailAddress":null, "taxForm":"W2", "pension":false, "statutory":false, "deceased":false, "deferredComp":false, "legalRep":false, "domesticEmpl":false, "seasonal":false, "i9Verified":false, "i9Reverify":null, "citizenship":null, "visaType":null, "visaExpiration":null, "unionCode":null, "unionDate":null, "unionInitFees":false, "unionDues":false, "supervisorID":null, "supervisorName":null, "lastRaiseDate":null, "lastRaiseAmount":null, "lastRaiseReason":null, "nextRaiseDate":null, "lastReviewDate":null, "lastReviewRating":null, "nextReviewDate":null, "user1":null, "user2":null, "user3":null, "user4":null, "user5":null, "user6":null, "user7":null, "user8":null, "miscCheck1":false, "miscCheck2":false, "miscCheck3":false, "miscCheck4":false, "miscCheck5":false, "ee401kDeferral":null, "ee401kCalc":null, "ee401kContinue":false, "ee401kEligibleDate":null, "ee401kStatus":null, "ee401kSuspendDate":null, "er401kMatch":null, "highComp":false, "owner":false, "ownerPercent":null, "ownerRelated":false, "ownerSSN":null, "memo":null, "showMemo":false, "workState":null, "officer":false, "wageType":"W", "family":false, "probation":false, "distributionCodes":null, "cellPhone":null, "ratePer":null, "payGrade":null } } , "properties":[ { "Name":"co", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":false }, { "Name":"id", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":false }, { "Name":"lastName", "Type":"VarChar", "Size":40, "DefaultValue":"", "Nullable":false }, { "Name":"firstName", "Type":"VarChar", "Size":40, "DefaultValue":"", "Nullable":false }, { "Name":"middleName", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"address1", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"address2", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"city", "Type":"VarChar", "Size":30, "DefaultValue":"", "Nullable":true }, { "Name":"state", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"zip", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"county", "Type":"VarChar", "Size":30, "DefaultValue":"", "Nullable":true }, { "Name":"country", "Type":"VarChar", "Size":30, "DefaultValue":"", "Nullable":true }, { "Name":"ssn", "Type":"VarChar", "Size":11, "DefaultValue":"", "Nullable":false }, { "Name":"birthDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"sex", "Type":"Char", "Size":1, "DefaultValue":"", "Nullable":true }, { "Name":"empStatus", "Type":"VarChar", "Size":20, "DefaultValue":"If blank the company defined default employee status", "Nullable":false }, { "Name":"empType", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"payGroup", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"hireDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"rehireDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"adjSeniorityDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"termDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"termReason", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"cc1", "Type":"VarChar", "Size":10, "DefaultValue":"If blank the company defined default cc1", "Nullable":true }, { "Name":"cc2", "Type":"VarChar", "Size":10, "DefaultValue":"If blank the company defined default cc2", "Nullable":true }, { "Name":"cc3", "Type":"VarChar", "Size":10, "DefaultValue":"If blank the company defined default cc3", "Nullable":true }, { "Name":"cc4", "Type":"VarChar", "Size":10, "DefaultValue":"If blank the company defined default cc4", "Nullable":true }, { "Name":"cc5", "Type":"VarChar", "Size":10, "DefaultValue":"If blank the company defined default cc5", "Nullable":true }, { "Name":"wcc", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"clock", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"defaultHours", "Type":"Decimal", "Size":0, "DefaultValue":"0", "Nullable":true }, { "Name":"payFrequency", "Type":"VarChar", "Size":10, "DefaultValue":"If blank the company defined default frequency", "Nullable":true }, { "Name":"autoPay", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"jobCode", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"tipped", "Type":"VarChar", "Size":5, "DefaultValue":"", "Nullable":true }, { "Name":"guidfield", "Type":"Guid", "Size":0, "DefaultValue":"A new globally unique identifier", "Nullable":false }, { "Name":"lastChange", "Type":"DBTimeStamp", "Size":0, "DefaultValue":"The current system time", "Nullable":false }, { "Name":"lastChangeUser", "Type":"VarChar", "Size":128, "DefaultValue":"", "Nullable":false }, { "Name":"password", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"salutation", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"surname", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"nickname", "Type":"VarChar", "Size":15, "DefaultValue":"", "Nullable":true }, { "Name":"priorLastName", "Type":"VarChar", "Size":30, "DefaultValue":"", "Nullable":true }, { "Name":"homePhone", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"ethnicity", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"maritalStatus", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"disabilityDesc", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"veteranDesc", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"smoker", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"positionCode", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"positionInfoLocked", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"title", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"eeoClass", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"flsaOTExempt", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"workPhone", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"workPhoneExt", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"mailStop", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"emailAddress", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"taxForm", "Type":"VarChar", "Size":10, "DefaultValue":"W2", "Nullable":false }, { "Name":"pension", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"statutory", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"deceased", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"deferredComp", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"legalRep", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"domesticEmpl", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"seasonal", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"i9Verified", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"i9Reverify", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"citizenship", "Type":"VarChar", "Size":30, "DefaultValue":"", "Nullable":true }, { "Name":"visaType", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"visaExpiration", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"unionCode", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"unionDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"unionInitFees", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"unionDues", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"supervisorID", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"supervisorName", "Type":"VarChar", "Size":30, "DefaultValue":"", "Nullable":true }, { "Name":"lastRaiseDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"lastRaiseAmount", "Type":"Decimal", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"lastRaiseReason", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"nextRaiseDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"lastReviewDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"lastReviewRating", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"nextReviewDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"user1", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user2", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user3", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user4", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user5", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user6", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user7", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"user8", "Type":"VarChar", "Size":50, "DefaultValue":"", "Nullable":true }, { "Name":"miscCheck1", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"miscCheck2", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"miscCheck3", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"miscCheck4", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"miscCheck5", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"ee401kDeferral", "Type":"Decimal", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"ee401kCalc", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"ee401kContinue", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"ee401kEligibleDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"ee401kStatus", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"ee401kSuspendDate", "Type":"DBDate", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"er401kMatch", "Type":"Decimal", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"highComp", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"owner", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"ownerPercent", "Type":"TinyInt", "Size":0, "DefaultValue":"", "Nullable":true }, { "Name":"ownerRelated", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"ownerSSN", "Type":"VarChar", "Size":11, "DefaultValue":"", "Nullable":true }, { "Name":"memo", "Type":"VarChar", "Size":4000, "DefaultValue":"", "Nullable":true }, { "Name":"showMemo", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"workState", "Type":"VarChar", "Size":5, "DefaultValue":"", "Nullable":true }, { "Name":"officer", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"wageType", "Type":"Char", "Size":1, "DefaultValue":"W", "Nullable":false }, { "Name":"family", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"probation", "Type":"Boolean", "Size":0, "DefaultValue":"0", "Nullable":false }, { "Name":"distributionCodes", "Type":"VarChar", "Size":128, "DefaultValue":"", "Nullable":true }, { "Name":"cellPhone", "Type":"VarChar", "Size":20, "DefaultValue":"", "Nullable":true }, { "Name":"ratePer", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true }, { "Name":"payGrade", "Type":"VarChar", "Size":10, "DefaultValue":"", "Nullable":true } ], "description":"Employees" }, "message":null }

getUnusedOnboardingUserName

Finds an unused user name for the specified onboarding portal.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/getUnusedOnboardingUserName

Example Body

{ "authorization":{ "loginToken":"", "password":"[PASSWORD+TOKEN]", "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "userType":0 }, "cPortalGuid": "61cb3613-6cb5-4443-81df-b1f691449611", "firstChoice":"AllPayTest", "wordList":[ "Test", "Info", "123", "ABC" ] }

RESPONSE

Example Body

{ "ok":true, "payload":"AllPayTest", "message":null }

costCentersPermittedToUser

The costCentersPermittedToUser method returns a list of the cost centers that a named user has rights to. In order to consume this method the authorization user must have rights to add users in AllPay.

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/costCentersPermittedToUser

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "userName":"UserName", "co":"Demo", "costCenterLevel":1 }

RESPONSE

Example Body

{ "ok":true, "payload":[ "000001", "000002", "000003", "000004", "000005", "000006", "000007", "93" ], "message":null }

createOnboardingNotification

Creates an HRJobQ record that either sends an email or generates a PDF enrollment letter for an onboarding user. During this process if the onboarding user does not have an initialPassword assigned it will create one for the user.

Parameters

  • onboardingUser - an EOnboard object
  • notificationType - 0 = Letter, 1 = Email

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/createOnboardingNotification

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "onboardingUser":{ "_objectType":"EOnboard", "entity":{ "co":"Demo", "becameEmpId":null, "oId":"27TT6S", "guidfield":"0021e2b8-d6a3-4557-aecd-4017eb3fef77", "lastChange":"2019-11-08T13:23:36.92", "lastChangeUser":"AllPay", "CPortalGuid":"67773897-736d-46c9-8bbc-0e92e50ee70f", "password":null, "complete":false, "emailAddress":"Karen@alliancepayroll.com", "expirationDate":"2019-09-19T00:00:00", "xferErrors":null, "userName":"bms1", "lastName":"BMW", "firstName":"Sky", "ssn":"321-32-1322", "initialPassword":"6p&#j7", "electronicSignature":null, "percentComplete":0.0, "testAccount":false, "existingEmpGuid":"60c5add1-ba9e-42fa-a680-9a7052b43efa", "applicantGuid":null, "dateSubmitted":null, "referrer":null, "lastEmailSent":"2019-11-08T13:23:36.88", "emailSendCount":2, "passwordSalt":null, "convertToEmpDate":null, "smsCode":null, "specifiedSelectFields":null, "isNew":false } }, "notificationType":1 }

RESPONSE

Example Body

{ "ok":true, "payload":{ "primaryKey":{ "fieldValue":"55bbabd7-8229-4679-8ab4-631da7d35718", "originalValue":"55bbabd7-8229-4679-8ab4-631da7d35718", "name":"guidfield" }, "tableName":"HRJobQ", "guidfield":"55bbabd7-8229-4679-8ab4-631da7d35718", "jobType":"EMail", "queuedUser":"Karen", "queuedTime":"2019-11-19T12:17:16", "notes":null, "starttime":"2019-11-19T12:17:21", "endtime":"2019-11-19T12:17:24", "processor":null, "props":"DestCo=Demo&RcptType=Onboarding&RcptCode=27TT6S&Email=Karen%40alliancepayroll.com&Subject=Welcome+Aboard+Sky&Body=%3cp%3eTo%3a+Sky+BMW%3c%2fp%3e%0d%0a%0d%0a%3cp%3eRe%3a+Welcome+Aboard&ReplyTo=Karen%40alliancepayroll.com", "co":"Demo", "status":"active", "result":null, "createdbyJob":"00000000-0000-0000-0000-000000000000", "priority":45, "identityvalue":443691, "outputFile":null, "Description":"Send Email Welcome Aboard Sky", "Precedent":null, "userMessage":null, "queuedUserType":"AllPay", "downloadAsFileName":null, "memDiff":null, "specifiedSelectFields":null, "isNew":false }, "message":null }

SubmitPayroll

REQUEST

URL

POST https://api2.hralliance.net/AllPayRestData.svc/json/submitPayroll

Example Body

{ "authorization":{ "requestExpiration":"2019-11-15T11:43:37.533-06:00", "userName":"[USERNAME]", "password":"[PASSWORD+TOKEN]", "userType":0, "loginToken":"" }, "co":"Demo", "calendarId":"61cb3613-6cb5-4443-81df-b1f691449611" }

RESPONSE

Example Body

{ "ok":true, "payload":{ "records":[ { "_objectType":"CCalendar", "entity":{ "primaryKey":{ "fieldValue":"61cb3613-6cb5-4443-81df-b1f691449611", "originalValue":"61cb3613-6cb5-4443-81df-b1f691449611", "name":"calendarId" }, "tableName":"CCalendar", "co":"Demo", "checkDate":"2011-07-15T00:00:00", "processGroup":null, "periodBegin":"2011-06-25T00:00:00", "periodEnd":"2011-07-10T00:00:00", "calendarId":"61cb3613-6cb5-4443-81df-b1f691449611", "status":"Scheduled", "periodBegunUserId":null, "scheduledProcessDate":"2011-07-13T00:00:00", "actualProcessDate":"0001-01-01T00:00:00", "processUserId":null, "process":0, "payrollNotes":null, "startPayrollJobId":"00000000-0000-0000-0000-000000000000", "processPayrollJobId":"00000000-0000-0000-0000-000000000000", "lastChange":"2017-03-29T15:06:50", "onhold":false, "processed":false, "packedUserId":null, "packedTime":"0001-01-01T00:00:00", "inTransitTime":"0001-01-01T00:00:00", "deliveredTime":"0001-01-01T00:00:00", "deliveryTracking":null, "deliveredBy":null, "lastChangeUser":"Root", "timeclockImportJobId":"00000000-0000-0000-0000-000000000000", "submitPayrollJobId":"00000000-0000-0000-0000-000000000000", "blockBilling":false, "blockAgency":false, "blockTransfers":false, "blockACH":false, "blockTaxDeposits":false, "blockAccruals":false, "deletePriorDep":false, "calendarScheduleID":"cd240b43-9acb-4400-aac7-2af672a8ea05", "sequence":1, "specifiedSelectFields":"", "isNew":false } } ], "recordCount":1, "queryIdentifier":null, "lastError":null, "fieldsToPopulate":null, "objectType":null }, "message":null }