Skip to main content

Frequently Asked Questions

1. What CMiC environments do you support?​

We support all CMiC instances, no matter if they are on-prem, using iPaaS, or cloud hosted.

We also support all the environments like train, test, conv, and prod.

You can see the hosting method and the environment you are on by looking at the URL you use to log into CMiC:

TK-img

2. What versions of CMiC do you support?​

We support all the CMiC versions with API access (which you may need to buy as a separate package from CMiC).

For Patch 19 and after, you would need to grant access to Agave in the "API Security Screen". See more docs below.

3. Where can I get the "client ID"?​

It's the same thing you put into the CMiC login screen. If your login screen doesn't contain this field, just leave it blank.


If you use SSO and/or skip the CMiC login screen, reach out to your CMiC consultant for the client ID info.

4. How can I set up a user for the integration?​

Agave can work with any user you have in CMiC, so you could use an existing user account. That said, we do recommend setting up a dedicated user account for Agave for clarity and permission-setting.

You can do so by adding a new user in the "User Maintenance" Screen:


See more in CMiC's official docs.

5. Is there an additional cost to adding a dedicated user?​

The Agave account will occupy a CMiC license. So if you don't have additional licenses, you may need to re-purpose one of your existing licenses or pay for a new one.

6. Do you support SSO (Single Sign-On)?​

Agave doesn't support SSO for CMiC. You can find the username and credential in CMiC's "User Maintenance" screen for Agave, even if the user is using SSO to log into the CMiC website.

7. What should I do to get the API enabled?​

Reach out to your CMiC rep.

8. Is there an additional cost to an API license?​

There can be. Reach out to your CMiC rep for that info.

9. What API permission should I give in the "API Security Screen"?​

Since Patch 19, CMiC added the "API Security Screen" to control the permission a user has to different API endpoints.

See CMiC's official docs for detailed tutorial and step-by-step setup guide.

Here's all the APIs Agave uses, you can grant access to the ones you want us to use.

ApplicationEndpointAPI DescriptionInsertUpdateDeleteQuery
AP-REST-APIapallvouchersAll Vouchers (Query only)NNNY
AP-REST-APIapinsuranceVendor Insurances/CompliancesYYYY
AP-REST-APIapreginvRegistered InvoicesYYYY
AP-REST-APIapreginvdetailsRegistered Invoice DistributionsNNNY
AP-REST-APIapvendorVendorsYYYY
AP-REST-APIapvoucherSC RFP Based VouchersYNNY
AP-REST-APIscrfpdetailSubcontract Request for Payment DetailsNNNY
AR-REST-APIarcustomerCustomersYYYY
AR-REST-APIartaxitemsTax CodesYYYY
AR-REST-APIarinvoiceInvoicesYYYY
CM-REST-APIcmdetailPCI DetailsYYYY
CM-REST-APIcmmastPCI MastersYYYY
CM-REST-APIcmstatusPCI Status CodeYYNY
CM-REST-APIcmownerchangeorderOwner Change OrdersYYNY
CM-REST-APIcmtypePCI TypesYYYY
EM-REST-APIemequipmentEquipmentYYYY
GL-REST-APIglcompanyCompaniesNNNY
HCM-REST-APIpyemptimesheetPY Generic TimesheetsYYNY
HCM-REST-APIpyemployeePY EmployeeYNNY
JC-REST-APIjcmastercategoriesMaster CategoriesNNNY
JC-REST-APIjcjobcostcodesJob Phases/Cost CodesNNNY
JC-REST-APIjcjobcategoryJob CategoriesYYYY
JC-REST-APIjcjobJobsYYNY
JC-REST-APIjcmastercostcodesMaster Phases/Cost CodesYYNY
PM-REST-APIpmprojcontactProject ContactsNNNY
PM-REST-APIpmprojectProjectsYYNY
PM-REST-APIpmprojpartnerProject PartnersYYNY
PM-REST-APIscmastSubcontract HeadersYYNY
PM-REST-APIscschedSubcontract DetailsYYNY
SYS-REST-APItermPayment TermsYYYY
SYS-REST-APIweightmeasureWeight MeasuresYYNY