CMiC Authentication
Agave connects to CMiC through its REST APIs, acting as a registered CMiC user. This guide covers the connection details Agave needs and the API access to grant that user.
This guide is for your CMiC administrator. You only need it once, when Expense Management and/or AP Automation are first connected.
This guide covers:
- The connection details Agave needs
- Whitelisting Agave's static IP addresses for on-premise CMiC
- The CMiC API endpoints Agave uses
Before you start
API access in CMiC is licensed separately. If your company has not enabled it, contact your CMiC Customer Success Manager for a quote before starting.
Expense Management uses the same CMiC user as your other Agave products. You do not need to create a second one, but it does need more API access than the other products do. See Additional endpoints for Expense Management below.
Step 1: Gather your connection details
Agave needs the following:
| Field | Where it comes from |
|---|---|
| Server | Your CMiC URL up to and including .com. For https://testrti.cmiccloudr12.com/cmictestrti/, this is https://testrti.cmiccloudr12.com |
| Environment | The text after .com in your CMiC URL. For the example above, this is cmictestrti |
| Client ID | The client registered in CMiC cloud. Not required for on-premise CMiC |
| Username | A registered CMiC user |
| Password | The password for that user |
Step 2: Whitelist Agave's static IP addresses
This step applies to on-premise CMiC only. Skip it if your CMiC instance is cloud hosted.
Ask your IT team to whitelist Agave's three static IP addresses so Agave can reach the CMiC database on your network:
- 13.58.14.240
- 18.219.160.98
- 3.143.37.24
These are the same three addresses used by every other Agave connection, so if you already run Agave against an on-premise system, they are already whitelisted.
If you are unable to authenticate even after adding the above static IP addresses, contact support@useagave.com.
CMiC API endpoints Agave uses
| Application | Endpoint | API Description | Insert | Update | Delete | Query |
|---|---|---|---|---|---|---|
| AP-REST-API | apallvouchers | All Vouchers (Query only) | N | N | N | Y |
| AP-REST-API | apvendor | Vendors | Y | Y | Y | Y |
| AP-REST-API | apvoucher | SC RFP Based Vouchers | Y | N | N | Y |
| AP-REST-API | scrfpdetail | Subcontract Request for Payment Details | N | N | N | Y |
| AR-REST-API | arcustomer | Customers | Y | Y | Y | Y |
| AR-REST-API | arinvoice | Invoices | Y | Y | Y | Y |
| CM-REST-API | cmdetail | PCI Details | Y | Y | Y | Y |
| CM-REST-API | cmmast | PCI Masters | Y | Y | Y | Y |
| CM-REST-API | cmstatus | PCI Status Code | Y | Y | N | Y |
| CM-REST-API | cmownerchangeorder | Owner Change Orders | Y | Y | N | Y |
| CM-REST-API | cmtype | PCI Types | Y | Y | Y | Y |
| GL-REST-API | glcompany | Companies | N | N | N | Y |
| JC-REST-API | jcmastercategories | Master Categories | N | N | N | Y |
| JC-REST-API | jcjobcostcodes | Job Phases/Cost Codes | N | N | N | Y |
| JC-REST-API | jcjobcategory | Job Categories | Y | Y | Y | Y |
| JC-REST-API | jcjob | Jobs | Y | Y | N | Y |
| JC-REST-API | jcmastercostcodes | Master Phases/Cost Codes | Y | Y | N | Y |
| PM-REST-API | pmprojcontact | Project Contacts | N | N | N | Y |
| PM-REST-API | pmproject | Projects | Y | Y | N | Y |
| PM-REST-API | pmprojpartner | Project Partners | Y | Y | N | Y |
| PM-REST-API | scmast | Subcontract Headers | Y | Y | N | Y |
| PM-REST-API | scsched | Subcontract Details | Y | Y | N | Y |
| SYS-REST-API | term | Payment Terms | Y | Y | Y | Y |
| SYS-REST-API | weightmeasure | Weight Measures | Y | Y | N | Y |
| SYS-REST-API | sdobjusrextvalue | User Extension Fields | Y | Y | N | Y |
Additional endpoints for Expense Management
Expense Management writes each expense as an AP voucher, posts it, and later pays it off with a manual check. That flow needs endpoints beyond the table above.
| Application | Endpoint | Used for |
|---|---|---|
| AP-REST-API | apvouchernosc | Creating the voucher that represents the expense |
| AP-REST-API | postvouchers | Posting the voucher batch once it is created |
| AP-REST-API | manualcheck | Creating the manual check that pays off posted vouchers |
| AP-REST-API | manualcheck/batch | Creating several checks in a single batch |
| GL-REST-API | glaccounts | GL accounts, including the account behind each card |
| ECM-REST-API | uploadDoc/upload | Uploading the receipt image |
| ECM-REST-API | ImgSources | Reading your Image Source ID |
| ECM-REST-API | ImgSourceDocTypeV | Reading your Document Type ID |
Expense Management posts vouchers and creates manual checks, which the other Agave products do not do. If you are adding Expense Management to an existing CMiC connection, confirm the user has permission for both. Voucher entry alone is not enough.
Related guides
- Accounting/ERP System Connection: finishing the connection in Agave once your system is configured