Task guides
Create an API token
Step-by-step task guide: Settings and security.
- Open Settings, then the API tokens tab. An API token is a password that lets another program read or change this client's data.
- Under Create a new token type a Name so you can recognise the token later.
- Choose the Tier: Read can only read, Draft can also change drafts, Request finalization can also ask for finalization but never finalizes by itself, a person always approves. Tick the Permissions the token needs and choose Valid for.
- Choose Create token. Your new token shows the token only this once: choose Copy, store it in a safe place, then choose I have saved the token.
- A token never has more rights than the person who created it. If that person's role is reduced or they leave, the token loses those rights too.
- A token reads payslips only when Read payslips (restricted receipts) is ticked and its creator may read them; every such read is recorded in the audit log.
- The list shows when each token Expires, when it was Last used and its Status. To stop a token, choose Revoke and confirm with Yes, revoke.
- A firm can have at most 50 live tokens; revoke one you no longer use before creating another. Every download of a document through a token is recorded in the audit log, and a token has a daily limit on how much it can write.