For clients using AIRINC data, a new Equus delivered API has been created that enables streamlined receipt and management of that data. This capability is built into the Equus Platform and includes an update to the Compensation Worksheet Data Provider Data screen to allow the review of data sent by AIRINC over the API. Use of this feature requires the following:
Client to have a subscription with AIRINC
Client's webserver configured to use the API - please contact your Equus representative. Configuration is done by the Equus Development Team.
In the Equus Platform, create an API subscriber with a subscription to the AIRINC API (select AIRINC from the list of available API Subscriptions) and generate GUID and Secret Key for the API subscriber - to be provided to AIRINC to enable integration between their systems and the client's instance.
Based on what is included in the Client's AIRINC subscription, AIRINC is able to manage data directly in the Equus Platform over the API. The data is stored in standard tables within the Equus Platform. While AIRINC can manage the data sets, clients may need to review new sets of data before using them for calculations powered by User Reports.
The Compensation Worksheet Data Provider Data screen has been updated to support handling data that has been sent by AIRINC. Navigate to the Compensation Worksheet Data Provider Data screen under Company Configuration and select <AIRINC API> as the Data Provider. Select the desired Data Type from the drop-down list and click
.
Depending on the Data Type that is selected, different fields will be displayed on the screen that can be used to filter the records in the backing table. For all Tables, Data Variation and Data Description are available for filtering and the drop drop-downs for each parameter will be populated based on what is in the table. Once filter criteria have been selected, click
. Depending on what type of data is being reviewed, additional data may be displayed in the results grid.
Additional data displayed in results grid: Departure and Arrival locations, Currency, Fare and Airport Codes (also available for filtering).
AIRINC GS Index
Additional data displayed in results grid: Home Currency, Host Currency, Exchange Rate and Index.
AIRINC Home Host
Additional data displayed in results grid: Data Period, Data Currency and Amount.
AIRINC Job Level
Additional data displayed in results grid: Data Currency, Data Period and Job Level (also available for filtering).
AIRINC Salary Grade
Additional data displayed in results grid: Data Currency, Exchange Rate, Salary Grade (also available for filtering) and Data Period.
AIRINC Salary Range
Additional data displayed in results grid: Data Period, Data Currency, Exchange Rate, Salary At Least and Salary Less Then (also available for filtering), Salary Currency, Salary Period and Tax Filing Status.
AIRINC Spendable Dual
Additional data displayed in results grid: Data Currency.
One, many, or all records in a result set can be selected and have the Status changed. The status is sent by AIRINC and is typically used to build filters in User Reports that back calculations. To select another Data Provider or Data Type click the
button.
In general, the tables are designed by data structure and can support multiple data types. Here is the list of supported tables for the AIRINC to Equus API:
Data Type | Data Structure | Equus Platform Standard AIRINC Table |
Airfare | Airfare departure to destination fares. Round-trip, one-way, fare parameters handled by Variation. | AIRINC_AIRFARE |
Auto | Auto costs by location | AIRINC_HOME_HOST |
G&S | COLA by salary range | AIRINC_SALARY_RANGE |
| COLA by salary grade | AIRINC_SALARY_GRADE |
| G&S Indexes | AIRINC_GSINDEX |
Education | Education costs by location (from ACE) | AIRINC_HOME_HOST |
Hardship | Hardship premium (%) by location | AIRINC_HOME_HOST |
| Hardship score (points) by location | AIRINC_HOME_HOST |
Hypo Housing | Home location hypo deduction by salary range | AIRINC_SALARY_RANGE |
| Home location hypo deduction by salary grade | AIRINC_SALARY_GRADE |
Immigration | Immigration costs by location (from ACE) | AIRINC_HOME_HOST |
Per Diem | Per diem costs by location - by individual data type or profile aggregation | AIRINC_HOME_HOST |
Rent | Host rent by USD salary range | AIRINC_SALARY_RANGE |
| Host rent by home salary range | AIRINC_SALARY_RANGE |
| Host rent by job level (IHG bands) | AIRINC_JOB_LEVEL |
| Host rent by salary grade | AIRINC_SALARY_GRADE |
Shipping | Shipping costs by home to host location (from ACE) | AIRINC_HOME_HOST |
Spendable Income | Spendable income by salary range | AIRINC_SALARY_RANGE |
| Spendable income by salary grade | AIRINC_SALARY_GRADE |
| Spendable income by 2-parameter factors | AIRINC_SPENDABLE_2 |
Tax | Tax amounts by salary range | AIRINC_SALARY_RANGE |
Utilities | Host utilities by USD salary range | AIRINC_SALARY_RANGE |
| Host utilities by home salary range | AIRINC_SALARY_RANGE |
| Host utilities by job level (IHG bands) | AIRINC_JOB_LEVEL |
| Host utilities by salary grade | AIRINC_SALARY_GRADE |
Data Supported by Equus API
Things to Note
Clients need to have an existing relationship with AIRINC or begin discussions around subscribing to AIRINC data in order to utilize this feature.
This screen will only hit the new standard AIRINC tables.
The new tables are available for User Reports; all the new tables are prefixed with AIRINC_.