API keys and developer access
If another system of yours — a webshop, an ERP, your own reports — needs to work with ControlliQ data, you can give it access with an API key.
What is the API good for?
Through the ControlliQ API, an external system can query your invoices, partners, master data, transactions and a summary report, add new partners, and send in documents for processing. You'll find the full description in the developer documentation — give it to your developer.
Creating a key
Permissions
| Permission | What it allows |
|---|---|
| Read invoices | List and view invoices, including downloading the original PDF |
| Read partners | List and view the partner directory |
| Create partners | Create a new partner |
| Read master data | List cost centers, job numbers and ledger numbers |
| Read transactions | List financial transactions |
| Upload documents | Upload a document for processing and check its status — uses credits |
| Read reports | Summary financial report for a period |
A key belongs to a single company and works with your permissions: whatever you can't see can't be fetched with the key either.
Revoking a key
In the list, click the Revoke button in the key's row. The system using the key loses access immediately, and this can't be undone — if you need it again, create a new key.
The list also shows when the key was last used and when it expires. If nothing has used a key for a long time, it's a good idea to revoke it.