Get started
Scopes
Every scope a key can hold and which routes it unlocks.
All scopes
Receivables, bookkeeping, statistics, and journal writes are only available on developer keys. AI assistant keys can't be given them.
A write scope also lets the key read that resource. For example, a key with bills:write can list and read bills without bills:read.
| Scope | Allows | AI assistant keys |
|---|---|---|
| companies:read | Company profile, currency, business type | Yes |
| coa:read | Chart of accounts | Yes |
| transactions:read | Bank and book transactions, and the review queue | Yes |
| journals:read | Journal entries and general ledger lines | Yes |
| reports:read | Financial reports, hotel KPIs, A/R aging, invoice and payment lists | Yes |
| reconcile:read | Reconciliation status and history | Yes |
| exceptions:read | Open review items and differences | Yes |
| banking:read | Linked institutions and sync status | Yes |
| items:read | Products and services (GET /items) | No |
| customers:write | Create, update, and read customers by external ID | No |
| invoices:write | Create, replace, void, and read invoices by external ID | No |
| payments:write | Record, void, and read customer payments by external ID | No |
| vendors:read | List and read vendors | No |
| vendors:write | Create, update, and read vendors | No |
| bills:read | List and read bills | No |
| bills:write | Create, edit, post, void, delete, and read bills | No |
| expenses:read | List and read expenses and card credits | No |
| expenses:write | Create, edit, post, void, delete, and read company-paid expenses and card credits | No |
| vendor_credits:read | List and read vendor credits | No |
| vendor_credits:write | Create, apply, refund, void, and read vendor credits | No |
| stats:read | Read daily room statistics (Hospitality) | No |
| stats:write | Set, delete, and read daily room statistics (Hospitality) | No |
| journals:write | Create, edit, post, void, and delete journal entries; daily revenue posting | No |
| transactions:write | Confirm ready-to-review transactions | Opt-in |
| reconcile:write | Create or update a statement reconciliation | Opt-in |