Guide Overview
This guide is designed to give Incident IQ administrators an overview of
- Managing InTouch API Integration
- Creating item categories and item types
- Review data imported by InTouch
Please see the following guide on how to add payments and fees to users, assets, and tickets:
Guide Index
You can use the following links below to quickly navigate to a specific section in this document. To quickly return to this index simply use the "Return to Index" link located at the end of each section.
- Getting Started
- Settings Tab
- Import Log Tab
- Errors Tab
- Item Categories Tab
- Item Types Tab
- Sync History Tab
- Export Tab
- Permissions
- FAQ
Getting Started
Below are the following required fields that need to match between iiQ and InTouch:
-
- School Id within iiQ must match InTouch field Student Id
- Sku within iiQ must match the InTouch field Item Collection
- Location Abbreviation (set up on the Locations page) within iiQ must match the InTouch field Fine Location Code
Next, you will need to go to Item Categories tab. Here, you set up the Item Categories of fees you use (ie. Library Fees, Technology Fees, etc). Then, you will need to go to the Item Types tab. Here, you will need to create the Items Types that can be charged (ie. Laptop Insurance Fee, Lost Book Fee, etc.)
Finally, you'll want to set permissions to control what users or roles should be able to create, edit and delete charges and fees.
Please see the additional article sections for more details on setting up Item Categories, Item Types, and Permissions.
Settings Tab
On the Setting tab enter in the number of days before a fee is overdue.
Import Log
On the Import Log tab you can view the raw data received from InTouch. You can search by the different data fields below:
- Message
- Import Status (Unprocessed, Imported, Error, Ignored)
- Raw Values
- Data Imported From and To
Errors Tab
Here you can view failed line item transfers between In Touch Payments Api and Incident IQ.
Item Categories
Item Categories are the fines for fees categories (i.e. course fees, library fines, device insurance, athletics). Click on the Item Categories tab. Then click Add New Item Category. Enter the Title of the category, along with the Description. Click Save.
When adding or editing and item category, you will need to Re-Build Payment Data after making all of your changes. Re-Build Payment Data is updating existing data for your grid column payment data to be displayed correctly. Click on Re-Build Payment Data.
You can Edit or Delete the category to the right.
Item Types
Item Types are the fees, payments or adjustments that associated to the Item Category. For example, under the Item Category library fines you can have item types: overdue, damaged, lost. Click on the Item Types tab. Then click Add New Item Type.
Next you will need to fill out the following fields:
- Sku: required to enter the item has a Sku.
Please note: Sku within iiQ must match the InTouch field Item Collection - Title: required to enter the items title.
- Description: enter in a description of the item.
- Category: required select which category the item is associated with.
- Type: required to select the type: fee, payment, adjustment.
- Default Amount: enter the default amount. This can be changed when issuing the payment or fee.
Click Save. You can Edit or Delete the item type to the right.
Sync History
This tab allows you to view your sync history between IIQ and InTouch. Every sync, whether it completed successfully or not, is logged for reference purposes and available for review.
Clicking on View Details will open that sync's details. From here, you can review the full list of payments that were added or number of errors.
Export
On the Export tab you can Export All Transactions. This will generate an excel file that contains all of transactions and information need (SKU, category, name, description, amount, due date and more.)
Permissions
Under the Permission tab you have access to limit which users can:
- Delete existing payment or fee transactions
- Modify existing payment or fee transactions
- Create a new payment or fee transactions
FAQ
- Do payments recorded in iiQ write back to InTouch? (ex: student pays cash or writes a check, agent adds payment in iiQ)
Yes, if a fines is recorded as paid in iiQ it will be removed from InTouch. - Does the sync from InTouch update fees on users account and the assets? (ex: if a fee is associated with a user and an asset it is paid in InTouch, does it update both the user and the asset with the next sync?)
Yes. When a payment comes in from InTouch, it will reference the fine that it is associated with user or asset. If this fine was associated with both a user and an asset, that fine will now be marked as paid, reducing the outstanding balance for both the user and the asset. - Are there any error logs or alerts/notifications for when an error has occurred during a sync?
No. But you can view any errors from the nightly sync on Errors Tab or the Import Log tab.